principle: specification-first development

[hhstore]

related:

• [x] xxx
• [x] xxx

[hhstore]

一种开发实践规范: 设计优先

关键词 :

• spec-first development
• specification-first API design.
• Spec-Driven Development
• 先设计, 后 coding.

理念:

• [x] Write the API documentation first

ref:

• [x] 此篇不错: https://www.davidkaya.com/specification-first-design/
• [x] https://goiabada.blog/using-spec-driven-development-to-build-consistent-apis-e391daafae71
• [x] https://www.atlassian.com/blog/technology/spec-first-api-development

工具:

• https://konghq.com/products/kong-enterprise/kong-studio/

• Kong Studio

• https://konghq.com/blog/introducing-insomnia-designer-an-open-source-collaborative-editor-for-api-design/

Insomnia Designer:

• 开源, 免费
• https://insomnia.rest/download/
• https://github.com/Kong/insomnia
• [x] 插件列表: https://insomnia.rest/plugins/

API Designer:

• https://github.com/mulesoft/api-designer

[hhstore]

Insomnia Designer

• https://support.insomnia.rest/collection/85-designer
• 使用教程: https://support.insomnia.rest/article/91-user-interface
• https://support.insomnia.rest/article/97-live-preview

[hhstore]

swaggerhub:

• https://app.swaggerhub.com/home
• 免费, 在线工具.

编辑器:

• 下载: https://swagger.io/tools/swagger-editor/download/
• https://github.com/swagger-api/swagger-editor

[hhstore]

openAPI 3.0 规范:

• https://swagger.io/specification/

https://swagger.io/specification/#parameter-object https://swagger.io/specification/#request-body-object https://swagger.io/specification/#response-object

[hhstore]

1

[hhstore]

xxxxxx:

xxxxxxxxxxxxxx	xxxxxxxxxxxxxx	xxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx