Swagger制作api

Posted hong

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Swagger制作api相关的知识,希望对你有一定的参考价值。

要制作哪个服务模块的在哪个服务里写

1.导入依赖

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.8.0</version>

</dependency>

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger-ui</artifactId>

    <version>2.8.0</version>

</dependency>

 

2.导入制作api模板

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .host("localhost:8085")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.leyou.user.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xx商城用户中心")
                .description("xx商城用户中心接口文档")
                .version("1.0")
                .build();
    }
}

3.访问:http://localhost:8085/swagger-ui.html

 

以上是关于Swagger制作api的主要内容,如果未能解决你的问题,请参考以下文章

csharp 在Swashbuckle Swagger中,此片段允许按字母顺序显示操作。

Django Rest Swagger生成api文档

Django Rest framework Swagger生成api文档

Swagger API文档

使用go-swagger为golang API自动生成swagger文档

Swagger UI教程 API 文档神器 搭配Node使用