如何使用swagger2轻松生成在线接口文档

  • 在pom.xml中引入依赖

            com.spring4all
            swagger-spring-boot-starter
            1.8.0.RELEASE
        

  • 在应用主类中增加@EnableSwagger2Doc注解
@SpringBootApplication
@EnableSwagger2Doc
public class SpringDataJpaApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringDataJpaApplication.class, args);
    }
}

  • 参数配置示例
swagger.enabled=true
swagger.title=spring-data-jpa module
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=RanRan Tao
swagger.contact.url=https://www.jianshu.com/u/822585e5c69a
[email protected]
swagger.base-package=com.example.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

  • 默认情况下就能产生所有当前SpringMVC加载的请求映射文档
    访问地址:http://localhost:8080/swagger-ui.html

你可能感兴趣的:(如何使用swagger2轻松生成在线接口文档)