标签：Swagger description tags 代码 value 说明 swagger

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。它可以在修改代码的同时同步修改接口文档，一个最大的优点是能实时同步api与文档

一些注解说明

对这些常用的注解及元素说明，具体的其他元素可以查看源码。

• @Api：用在类上
  - tags：描述类的用途
  - description：注释说明这个类
  - 其实tags和description这俩都差不多都是对这个类的说明
  

  @ApiOperation：用在方法上
  - value：字段说明
  - notes：注释说明
  - response：方法的返回类型

   

   

   

  @ApiParam：用在参数上
  - name：参数名称
  - required：是否必传

  

   

   

  
  @ApiModel：用在入参或回参的对象类上
  - value：对这个类进行说明
  - description：说明这个类
  - 和@Api的tags/description一样，都是起说明作用

  

   

   

  
  @ApiModelProperty：用在对象类中的变量上
  - value：对这个字段的说明
  - example：字段举例

  

   

   

  
  @EnableSwagger2：配置swagger时启用swagger

• 

   

   

•  

  到这里，就可以在代码中简单使用swagger，访问地址(http://localhost:9090/swagger/swagger-ui.html),但是作为励志成为技术大牛的菜鸟，这点那肯定是不能够满足我的，既然知道了使用，那么swagger时怎么导出的呢，这是个大问题，在这里我在网上学习了两种方式进行导出，分别问使用maven和代码方式，但是使用maven导出的时候频频出错，没办法我只有自己找问题改代码了，代码中可能有待优化的部分，不喜勿怪!
  
  

标签：Swagger,description,tags,代码,value,说明,swagger
来源： https://www.cnblogs.com/labimeilexin/p/16326422.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。