springfox+swagger2生成API文档

1、建立一个spring mvc工程;

2、添加POM依赖:

 1 <properties>
 2     <springfoxversion>2.6.1</springfoxversion>
 3 </properties>
 4 <dependencies>
 5     <dependency>
 6         <groupId>io.springfox</groupId>
 7         <artifactId>springfox-swagger2</artifactId>
 8         <version>${springfoxversion}</version>
 9         <scope>compile</scope>
10     </dependency>
11 </dependencies>
12
13 <dependency>
14     <groupId>com.fasterxml.jackson.core</groupId>
15     <artifactId>jackson-databind</artifactId>
16     <version>2.6.6</version>
17 </dependency>

3、config类

 1 @Configuration //必须存在
 2 @EnableSwagger2 //必须存在
 3 @EnableWebMvc //必须存在
 4 @ComponentScan(basePackages = {"org.blog.controller"}) //必须存在 扫描的API Controller package name 也可以直接扫描class (basePackageClasses)
 5 public class WebAppConfig{
 6     @Bean
 7     public Docket customDocket() {
 8         //
 9         return new Docket(DocumentationType.SWAGGER_2)
10                 .apiInfo(apiInfo());
11     }
12
13     private ApiInfo apiInfo() {
14         Contact contact = new Contact("周发扬", "https://cc520.me", "[email protected]");
15         return new ApiInfo("Blog前台API接口",//大标题 title
16                 "Blog前台API接口",//小标题
17                 "0.0.1",//版本
18                 "www.fangshuoit.com",//termsOfServiceUrl
19                 contact,//作者
20                 "Blog",//链接显示文字
21                 "https://cc520.me"//网站链接
22         );
23     }
24 }

4、编写Controller

 1 @Controller
 2 @RequestMapping("/home")
 3 public class test1 {
 4
 5     @ApiOperation(value="一个测试API",notes = "第一个测试api")
 6     @RequestMapping("/index")
 7     @ResponseBody
 8     public String index() {
 9         return "index";
10     }
11
12 }

6、web.xml增加能访问html文件的代码

 1 <servlet-mapping>
 2         <servlet-name>default</servlet-name>
 3         <url-pattern>*.css</url-pattern>
 4     </servlet-mapping>
 5     <servlet-mapping>
 6         <servlet-name>default</servlet-name>
 7         <url-pattern>*.js</url-pattern>
 8     </servlet-mapping>
 9     <servlet-mapping>
10         <servlet-name>default</servlet-name>
11         <url-pattern>*.jpg</url-pattern>
12     </servlet-mapping>
13     <servlet-mapping>
14         <servlet-name>default</servlet-name>
15         <url-pattern>*.png</url-pattern>
16     </servlet-mapping>
17     <servlet-mapping>
18         <servlet-name>default</servlet-name>
19         <url-pattern>*.html</url-pattern>
20     </servlet-mapping>
21     <servlet-mapping>
22         <servlet-name>default</servlet-name>
23         <url-pattern>*.htm</url-pattern>
24     </servlet-mapping>

7、运行,浏览器中打开“http://127.0.0.1:8080/test/v2/api-docs”或者“http://127.0.0.1:8080/test/swagger-ui.html”查看

原文地址:https://www.cnblogs.com/laoxia/p/9311525.html

时间: 2024-10-18 04:18:12

springfox+swagger2生成API文档的相关文章

SpringBoot+rest接口+swagger2生成API文档+validator+mybatis+aop+国际化

代码地址:JillWen_SpringBootDemo mybatis 1. 添加依赖: <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis.version}</version> </dependency> &

Spring Boot中使用Swagger2构建API文档

程序员都很希望别人能写技术文档,自己却很不愿意写文档.因为接口数量繁多,并且充满业务细节,写文档需要花大量的时间去处理格式排版,代码修改后还需要同步修改文档,经常因为项目时间紧等原因导致文档滞后于代码,接口调用方的抱怨声不绝于耳.而程序员是最擅长"偷懒"的职业了,自然会有多种多样的自动生成文档的插件.今天要介绍的就是Swagger. 接下来我们在Spring Boot中使用Swagger2构建API文档 Swagger是一个简单但功能强大的API表达工具.它具有地球上最大的API工具生

白话SpringCloud | 第十一章:路由网关(Zuul):利用swagger2聚合API文档

前言 通过之前的两篇文章,可以简单的搭建一个路由网关了.而我们知道,现在都奉行前后端分离开发,前后端开发的沟通成本就增加了,所以一般上我们都是通过swagger进行api文档生成的.现在由于使用了统一路由网关了,都希望各微服务的api文档统一的聚合在网关服务中,也方便前端用户查阅,不需要每个服务单独查看.当然了,也是可以做一个文档索引网页进行各微服务的api文档链接的.今天,我们就来讲下使用swagger实现自动化聚合微服务文档功能. 注:关于Swagger的介绍和使用,由于在之前的Spring

vs2010代码注释自动生成api文档

最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安装Sandcastle 和Sandcastle Help File Builder 下载地址 http://sandcastle.codeplex.com/ http://shfb.codeplex.com/ 其中Sandcastle Help File Builder安装较复杂,安装红框内的即可 安装完成后,然后让要使用的项目输出xml

利用sphinx为python项目生成API文档

sphinx可以根据python的注释生成可以查找的api文档,简单记录了下步骤 1:安装 pip install -U Sphinx 2:在需要生成文档的.py文件目录下执行sphinx-apidoc -F -o ./doc ./domain/model/ 在当前目录下新建doc目录,api文档的文件夹就在此目录下,./domain/model/ 表示需要生成api文档的目录. 3:进入doc目录 修改conf.py文件 设置代码路径为sys.path.insert(0, os.path.ab

PHP的学习--使用PhpDocumentor 2生成API文档

官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @link

PHP读取注释生成api文档

总结就是,正则要用的好. 需要生成api的class文件: <?php class emailAction { /** * @method 发送邮件 * @url email/send?token=xxx * @http POST * @param token string [必填] 调用接口凭证 (post|get) * @param ema_type enum [必填] 发送速度:'普通','紧急','延时' * @param ema_from enum [必填] 来源:'B2C','主站'

iOS开发日记23-Xcode生成API文档(HeaderDoc)

今天博主有一个Xcode生成API文档的需求,遇到了一些困难点,在此和大家分享,希望能够共同进步. 今天公司和客户交接源码,但是客户提出不仅需要源码,还需要相应的技术文档,今天博主就和大家分享一下,如何使用Xcode生成你的技术文档. 生成技术文档主要有三个工具: headerdoc, doxygen 和 appledoc.其中headerdoc是苹果官方的生成工具,后两个是第三方工具.如果Xcode版本更新,则需要重新配置第三方工具,个人感觉虽然功能强大,但是配置繁琐,推荐大家使用header

.net 提取注释生成API文档 帮助文档

提取注释生成API文档 一.前言 在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险. 对于.Net,我们可以直接将类.方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量. 下面我们使用.Net唯一的注释生成API文档工具——Sandcastle和Sandcastle Help File Builder来实现API文档