zoukankan      html  css  js  c++  java
  • 用Swagger生成接口文档

    Swagger简介

    在系统设计的时候,各个应用之间往往是通过接口进行交互的。因此接口的定义在整个团队中就变得尤为重要。我们可以把接口的规范用接口描述语言进行描述,然后Swagger可以根据我们定义的接口规范生成对应的接口文档。它生成的接口文档提供了接口测试功能。我们只需要填上对应的参数,然后点击调用,就可以完成一次接口测试,非常方便。就像下图展示的那样。

    不仅如此,Swagger还能够根据接口规范自动生成对应的接口代码!比如Java客户端代码、Java服务端代码等。这个东西减少了接口规范的沟通成本,让开发人员能够直奔主题进行编码。开发人员甚至都不需要写客户端的代码了,只需要实现服务端代码即可。

    Swagger使用方法

    首先,打开Swagger的编辑器。通过网页也可以打开:http://editor.swagger.io/。打开之后是下图这样,按照它给的格式就可以写出接口文档啦~

    小结

    Swagger节省了开发人员的时间。只需编写一次接口规范,就可以多次使用。用程序员的话来讲就是提高了接口规范的可复用性。

  • 相关阅读:
    1270. 数列区间最大值(climits用法+线段树模板题)
    JDBC&DBCP总结
    1264. 动态求连续区间和(树状数组模板题)
    788. 逆序对的数量(归并排序的应用)
    归并排序(模板题)
    ZoomEye技巧
    工具或安全监测网站(不定时更新)
    bp截包
    CTF/web
    CTF/stega——图片隐写
  • 原文地址:https://www.cnblogs.com/jpfss/p/9962588.html
Copyright © 2011-2022 走看看