1. 程式人生 > 實用技巧 >swagger線上文件

swagger線上文件

swagger

生成線上文件:

一、在maven中的配置

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <
version>2.1.3</version> <exclusions> <exclusion> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> </exclusion> </
exclusions> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> <version>2.9.8</version> <!-- 版本可以使用2.9.3、2.9.5 、2.9.8,不能忽略version屬性--> </dependency>

二、然後在java中使用一下配置監聽需要展示的介面

@Configuration
@EnableSwagger2
public class Swagger {
   @Bean
   public Docket docket(){
       return new Docket(DocumentationType.SWAGGER_2)
         .apiInfo(apiInfo())
         .select()
         .apis(RequestHandlerSelectors.basePackage("com.HPMS.common.controller"))
         .paths(PathSelectors.any())
         .build();
   }

   public ApiInfo apiInfo(){
       return new ApiInfoBuilder()
         .title("利用swagger2構建的API文件")
         .description("用restful風格寫介面")
         .termsOfServiceUrl("")
         .version("1.0")
         .build();
   }
}

三、最後訪問http://localhost:8081/swagger-ui.html可以檢視當前系統的線上文件