JimmyLv / JimmyLv/jimmylv.github.io

如何描述 API 契约,便于 TL/Dev/BA 跨角色沟通与协作?

Open
#202 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
731
Forks
114
PR merge metrics
No merged PRs in 30d

Description

## 项目纵向拆分

> “普元选择的对 API 契约的描述方式,是参考 swagger spec 规范,使用 yaml 语言来描述。当然,swagger 的描述是针对 restful 接口的,我们可以针对自己接口定义的需要,自定义自己的描述属性。”

深入浅出聊聊企业级API网关:http://mp.weixin.qq.com/s/j6OuJ8KwClWaJokofiN8wQ

### ⓵ 定义目标和原则

### ⓶ 展望结果

### ⓷ 头脑风暴

### ⓸ 组织整理

### ⓹ 明确「下一步行动」

- 调研 [Swagger Editor](http://swagger.io/swagger-editor/)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.