SpringBootSwagger构建REST API并生成API文档

引入Maven依赖

 <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.2.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version></dependency>

启用 @EnableSwagger2

package com;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 Swagger2 {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("API文档构建Restful Api").description("更多Spring Boot相关文章请关注：http://www.xialeme.com/").termsOfServiceUrl("http://www.xialeme.com/").contact("zjcjava@163.com").version("1.0").build();}
}

SpringBootSwagger构建REST API并生成API文档相关推荐

WebAPI——自动生成帮助文档
Web Api 自动生成帮助文档新建Web Api项目之后,会在首页有API的导航菜单,点击即可看到API帮助文档,不过很遗憾,Description 是没有内容的. 怎么办呢? 第一步: 如果用V ...
Api 接口文档是什么？如何直接使用 ApiDoc 生成接口文档
api接口文档现代化开发大部分都是一种前后端分离的开发模式,前端与后端分别独立进行开发.等后续再去统一的联调.前后端分离的开发模式下,前后端沟通的成本增加,如何减少口头的交流成了关键.这时有一份高端 ...
Flask搭建api服务-生成API文档
前面讲到了Flask实现api,但api是给别人用的,就要告诉别人如何发现api,以及api的用途.名称.出参.入参,生成api文档的做法有好多种,本文选了一种最简单的方式. 核心就是通过app.vi ...
使用sphinx快速为你python注释生成API（html）文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...
beego API开发以及自动化文档
2019独角兽企业重金招聘Python工程师标准>>> beego API开发以及自动化文档 beego1.3版本已经在上个星期发布了,但是还是有很多人不了解如何来进行开发,也是在一 ...
【人工智能 Open AI】通用 API 网关系统（API Gateway）系统设计文档
怎样设计一个通用 API 网关系统(API Gateway)?给出具体的技术方案,细化到3级目录,不少于3000字.用markdown格式输出. 通用 API 网关系统(API Gateway)系统设 ...
Java8 API在线中文阅读文档
Java8 API在线中文阅读文档 Java8 API chm格式链接: https://pan.baidu.com/s/1vvxrBtf0we0Y6Q19q0k2Yw 提取码: etnw
JAVA 短信API接口调用附文档 Demo
JAVA 短信API接口调用附文档 Demo 1.请求地址 http://host:port/sms 请求方式可以 POST 和 GET方式,建议采用POST方式 2.参数说明参数需要 URLE ...
springboot+maven/gradle整合swag及生成静态文档
springboot整合swag及生成静态文档完整git地址 maven项目 gradle项目 pom文件如下 1.springboot整合swagger生成在线api 1.1 目录结构 1.2 p ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...

SpringBootSwagger构建REST API并生成API文档

SpringBootSwagger构建REST API并生成API文档相关推荐

最新文章

热门文章