基于swagger的RESTful API

基于swagger的RESTful API

摘要: 前言 RESTful架构,是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。后端通过提供一套标准的RESTful API,让网站移动端第三方系统都可以基于API进行数据交互和对接,极大的提高系统的开发效率,也使得前后端分离架构成为可能。 …


基于swagger的RESTful API_第1张图片

  • 基于swagger的RESTful API
    • 前言
    • 以下为自己整理的swagger UI 使用步骤
        • 首先用git获取swagger UI 代码
        • 然后将代码中 dist内容复制到项目中
          • 以下为个人习惯配置
        • 修改 indexhtml
        • 根据接口修改 配置的swaggerjson文件

前言

RESTful架构,是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。后端通过提供一套标准的RESTful API,让网站,移动端和第三方系统都可以基于API进行数据交互和对接,极大的提高系统的开发效率,也使得前后端分离架构成为可能。
因此,不同的测试,开发团队(前端,移动端,第三方接入者等)都需要围绕API进行开发工作,API的规范和文档对于团队开发,测试变得越来越重要。除了一份标准的文档,我们还希望API能够在线测试使用,从而有更直观的API使用体验,降低API的学习成本。这些对于团队的开发协作都会事半功倍。
本文将介绍一些API文档和开发测试方面的一些实践,使用typeson,docson,swagger-ui等开源工具,建立一个API的集设计,实现,测试,文档的一体化可视平台,让API的开发和使用更加高效。

  • Swagge
    Swagger是一种和语言无关的规范和框架,用于定义服务接口,主要用于描述RESTful的API。它专注于为API创建优秀的文档和客户端库。支持Swagger的API可以为API方法生成交互式的文档,让用户可以通过以可视化的方式试验,查看请求和响应、头文件和返回代码,从而发现API的功能。它本身就非常强大,但是Swagger框架还支持为多种流行的语言——包括JavaScript、Python、Ruby、Java、Scala等等——生成客户端代码。
    swagger [github地址][(2]
  • Swagger-UI
    为基于Swagger规范的API生成基于基于纯粹HTML,javascript,css的在线可视化文档,同时也能成为API的在线测试工具。
    swagger UI github地址

以下为自己整理的swagger UI 使用步骤

1. 首先用git获取swagger UI 代码

2. 然后将代码中 dist内容复制到项目中

以下为个人习惯配置
  • 在入口处添加swagger 和 api-docs 两个文件
  • dist 中内容 复制到 swagger中, 将 dist/json/swagger.json 复制到 api-docs中

3. 修改 index.html

修改代码

  
  
  
  

   
                    
                    

你可能感兴趣的:(swagger)