货币交易项目-环境搭建 (一)-API 的搭建

一、Swagger2简介

Swagger2是一套围绕OpenAPI 规范构建的开源工具,可以帮助您设计、构建、记录和使用REST API 。

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。它提供了人类可读和机器可读的文档格式。它提供了JSON和UI支持。JSON可以用作机器可读的格式,而 Swagger-UI 是用于可视显示的,通过浏览api文档,人们很容易理解它。

file

我们在项目中集成Swagger,编写项目的Swagger 注解后,项目就会生成一份 Swagger 接口,但是我们将项目关闭后,前端就无法访问该文档了,因此,还需要给前端搭建一套API的接口展示服务,减少前端与后端的沟通成本。

二、YAPI

简介

YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

特性

  • 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
  • 扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
  • 不仅有类似 postman 的接口调试,还有强大的测试集功能
  • 免费开源,内网部署,信息再也不怕泄露了!
  • 支持 postman, har, swagger 数据导入

私有云部署

1、启动 YApi-mongo:

docker run -d --name mongo-yapi mongo

2、初始化yapi:
初始化数据库索引及管理员账号

docker run -it --rm \
     --link mongo-yapi:mongo \
         --entrypoint npm \
         --workdir /api/vendors \
         registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
         run install-server

3、启动YApi:

 docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js

4.访问
访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org

file

file

可以看到,YAPI管理的API界面非常美观。


相关文章:
使用docker搭建YAPI服务

为者常成,行者常至