2019-12-31 Api接口文档管理工具 SwaggerUI

Swagger 官方文档https://swagger.io

导入pom依赖
 <!-- swagger2 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.4.0</version>
    </dependency>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.4.0</version>
    </dependency>
新建一个配置类（SwaggerConfig）
@Configuration
@EnableWebMvc
@EnableSwagger2
public class Swagger2Config extends WebMvcConfigurerAdapter {

    @Bean
    public Docket buildDocket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInfo());
        docket = docket.select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()).build();
        return docket;
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    private ApiInfo buildApiInfo() {
        return new ApiInfoBuilder()
                .title("RestApi docs")
                .termsOfServiceUrl("http://www.github.com/kongchen/swagger-maven-plugin")
                .build();
    }
}
Controller类中注解
@Api(tags = "hello测试接口")
@RequestMapping("/test")
@Controller
public class HelloWorldController {

    @Autowired
    private HelloWorld helloWorld;

    @ApiOperation(value = "返回字符串 hello", notes = "可以注解接口参数信息")
    @GetMapping("/hello")  //建议：请求类型写清楚（get/post），以便接口文档中可以单击打开
    @ResponseBody
    public String hello(){
       return helloWorld.helloWorld();
    }
}

建议：请求类型写清楚（get/post），以便接口文档中可以单击打开

输出本地URL和端口 进入Swagger页面
http://localhost:3003/swagger-ui.html
Swagger页面
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成，浏览时请结合常识与多方信息审慎甄别。
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容