`
GodJohnny
  • 浏览: 93929 次
  • 性别: Icon_minigender_1
  • 来自: 南京
社区版块
存档分类
最新评论

swagger/springfox 使用杂记

阅读更多
参考资料:
  • http://heidloff.net/article/usage-of-swagger-2-0-in-spring-boot-applications-to-document-apis/
  • http://jakubstas.com/spring-jersey-swagger-create-documentation/#.WAcMhvl96Cp
  • http://springfox.github.io/springfox/


备忘几个常用的注解:
1、@ApiIgnore 用于屏蔽一些不想在文档中显示的接口
2、tag的使用
   有一些接口定义,写在不同的Controller中,但在文档中想显示在同一个分组中时。可以用tag来标记这个接口,如:
  
@ApiOperation(tags = { "IdentityInfo" }, value = "获取用户认证信息", httpMethod = "GET")

   在构造Docket Java Bean时,定义这些tag及描述,如:
   
.tags(new Tag("IdentityInfo", "用户在XX系统中的相关状态"))

3、获取swagger用的JSON文件的方式:
  http://localhost:8080/v2/api-docs
  获取该应用中的接口定义的JSON。可在swagger-editor中导入并重新编辑这些文件。
4、API页面不显示 basic-error-controller : Basic Error Controller
  在构造Docket时,使用
 
.paths(Predicates.not(PathSelectors.regex("/error"))).build()

分享到:
评论

相关推荐

    swagger-core_2.9.1-1.3.0.jar

    com/wordnik/swagger/config/ConfigFactory.scala com/wordnik/swagger/config/FilterFactory.scala com/wordnik/swagger/config/ScannerFactory.scala com/wordnik/swagger/config/SwaggerConfig.scala ...

    swagger2.zip

    -- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> <groupId>io....

    springfox-swagger-common-3.0.0-API文档-中英对照版.zip

    赠送jar包:springfox-swagger-common-3.0.0.jar; 赠送原API文档:springfox-swagger-common-3.0.0-javadoc.jar; 赠送源代码:springfox-swagger-common-3.0.0-sources.jar; 赠送Maven依赖信息文件:springfox-...

    springfox-swagger2-3.0.0-API文档-中文版.zip

    赠送jar包:springfox-swagger2-3.0.0.jar; 赠送原API文档:springfox-swagger2-3.0.0-javadoc.jar; 赠送源代码:springfox-swagger2-3.0.0-sources.jar; 赠送Maven依赖信息文件:springfox-swagger2-3.0.0.pom;...

    swagger-ui

    7. **兼容性**:Swagger UI 支持 OpenAPI 3.0.x 和 2.0 规范,因此可以处理广泛使用的 API 描述。 8. **部署灵活性**:Swagger UI 可以作为一个独立的应用程序运行,也可以嵌入到现有的 Web 应用程序中。 在压缩包...

    springfox-swagger2-2.7.0-API文档-中文版.zip

    赠送jar包:springfox-swagger2-2.7.0.jar; 赠送原API文档:springfox-swagger2-2.7.0-javadoc.jar; 赠送源代码:springfox-swagger2-2.7.0-sources.jar; 赠送Maven依赖信息文件:springfox-swagger2-2.7.0.pom;...

    springfox-swagger2-2.9.2-API文档-中文版.zip

    赠送jar包:springfox-swagger2-2.9.2.jar; 赠送原API文档:springfox-swagger2-2.9.2-javadoc.jar; 赠送源代码:springfox-swagger2-2.9.2-sources.jar; 赠送Maven依赖信息文件:springfox-swagger2-2.9.2.pom;...

    swagger中文bug的js补丁

    最近我改造了一个遗留的restful接口系统,没有文档,所以我打算加一个动态的api框架--swagger 添加的过程中我发现了一...路径:src/main/resources/META-INF/resources/webjars/springfox-swagger-ui/swagger-ui.min.js

    springfox-swagger-common-3.0.0-API文档-中文版.zip

    赠送jar包:springfox-swagger-common-3.0.0.jar; 赠送原API文档:springfox-swagger-common-3.0.0-javadoc.jar; 赠送源代码:springfox-swagger-common-3.0.0-sources.jar; 赠送Maven依赖信息文件:springfox-...

    springfox-swagger2-2.9.2-API文档-中英对照版.zip

    赠送jar包:springfox-swagger2-2.9.2.jar; 赠送原API文档:springfox-swagger2-2.9.2-javadoc.jar; 赠送源代码:springfox-swagger2-2.9.2-sources.jar; 赠送Maven依赖信息文件:springfox-swagger2-2.9.2.pom;...

    springfox-swagger-common-2.7.0-API文档-中文版.zip

    赠送jar包:springfox-swagger-common-2.7.0.jar; 赠送原API文档:springfox-swagger-common-2.7.0-javadoc.jar; 赠送源代码:springfox-swagger-common-2.7.0-sources.jar; 赠送Maven依赖信息文件:springfox-...

    swagger所有相关jar包

    使用Swagger和Springfox,开发者可以实现以下功能: 1. **API文档自动化**:Springfox能够自动分析你的代码,生成准确的API文档,无需手动编写。 2. **交互式文档**:Swagger UI提供了实时的、交互式的API文档,...

    Swagger 解析器的使用

    Swagger 解析器 注意:如果您正在寻找 swagger-parser 1.X 和 OpenAPI 2.0,请参阅 v1 分支 注意:从 2.1.0 版开始,Swagger Parser 支持 OpenAPI 3.1;详情请参阅此页面

    Springboot集成Swagger详解经过

    import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket docket() { return new Docket(DocumentationType...

    Springfox(Swagger2)结合Springmvc

    Springfox,前身为Swagger2,是一款强大的开源框架,它使得在Spring MVC应用中集成Swagger变得更加简单。Swagger的主要目标是提供一套完整的、与语言无关的API描述标准,以便开发者能够轻松地构建具有高质量文档的...

    230206-028shopDemo(抽离UseSwagger管道集成中间件)

    “http://localhost:8090/Swagger/index.html”页面会出现“404”错误。 application.UseSwagger(); application.UseSwaggerUI(); //该自定义管道中间件设定/Swagger/index.html为默认启动页面。 //注意:在IIS...

    jsonapi-swagger:创建一个JSONAPI Swagger

    JSONAPI Swagger 生成JSONAPI Swagger文档。 安装 将此行添加到您的应用程序的Gemfile中: gem 'jsonapi-swagger' 然后执行: $ bundle 或将其自己安装为: $ gem install jsonapi-swagger 用法 配置jsonapi ...

    springfox-swagger2-2.2.2-API文档-中文版.zip

    赠送jar包:springfox-swagger2-2.2.2.jar; 赠送原API文档:springfox-swagger2-2.2.2-javadoc.jar; 赠送源代码:springfox-swagger2-2.2.2-sources.jar; 赠送Maven依赖信息文件:springfox-swagger2-2.2.2.pom;...

    springboot-swagger2-demo.rar

    在这个"springboot-swagger2-demo"项目中,开发者已经预先配置好了一个可直接运行的示例,使用了SpringBoot 2.1.1版本和Swagger2 2.29版本。下面我们将详细探讨这两个关键组件以及它们如何协同工作。 **SpringBoot*...

    springfox-swagger-common-2.4.0-API文档-中文版.zip

    赠送jar包:springfox-swagger-common-2.4.0.jar; 赠送原API文档:springfox-swagger-common-2.4.0-javadoc.jar; 赠送源代码:springfox-swagger-common-2.4.0-sources.jar; 包含翻译后的API文档:springfox-...

Global site tag (gtag.js) - Google Analytics