swagger2的demo

一时失言乱红尘 2023-01-01 02:54 76阅读 0赞

[swagger开发者博客][swagger]

#### 结构 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NpZWxfWQ_size_16_color_FFFFFF_t_70]

#### 代码： ####

[https://github.com/Ciel1998/swagger][https_github.com_Ciel1998_swagger]

#### 效果 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NpZWxfWQ_size_16_color_FFFFFF_t_70 1]

#### pom ####

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.9.2</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.9.2</version>
            </dependency>

SpringFoxConfig

@Configuration
    @EnableSwagger2
    public class SpringFoxConfig {
    
           @Bean
        public Docket apiDocket() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .select()
    //                .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .apis(RequestHandlerSelectors.basePackage("com.liziyi.tang"))
    //                .paths(PathSelectors.ant("/v2/**"))
                    .build()
                    .apiInfo(getApiInfo());
        }
        private ApiInfo getApiInfo() {
            return new ApiInfo(
                    "liziyi的swagger",
                    "描述暂无",
                    "V1.0",
                    "http://www.baidu.com",
                    new Contact("liziyi", "http://www.baidu.com", "xxxxxxx@163.com"),
                    "LICENSE",
                    "http://www.baidu.com",
                    Collections.emptyList()
            );
        }
    }

controller

@EnableSwagger2
    @RestController
    @RequestMapping("/v2/persons/")
    @Api(description = "Set of endpoints for Creating, Retrieving, Updating and Deleting of Persons.")
    public class PersonController {
        @RequestMapping(method = RequestMethod.GET, produces = "application/json")
        @ApiOperation("Returns list of all Persons in the system.")
        public String getAllPersons() {
            return "wagger";
        }
    }

[swagger]: https://www.vojtechruzicka.com/documenting-spring-boot-rest-api-swagger-springfox/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NpZWxfWQ_size_16_color_FFFFFF_t_70]: /images/20221120/66227c40fb734a8b84a98d0769878fdb.png
[https_github.com_Ciel1998_swagger]: https://github.com/Ciel1998/swagger
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NpZWxfWQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201230204912632.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NpZWxfWQ==,size_16,color_FFFFFF,t_70