Potential to make use of Swagger / OpenAPI definitions

未关闭
#102 0 条评论 11 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
openapi
领域
api, documentation

调研方向

首先审查当前的公共 API 文档以及其中定义的呈现方式;issue 中没有指定具体的文件、测试或入口点。在实现之前,明确哪些 Swagger/OpenAPI 版本、端点以及生成的或手写的工件属于范围,并以支持已达成一致的 API 定义作为完成标准。

由索引模型根据 Issue 内容生成。

描述

More and more Restful API's are making use of Swagger/OpenAPI for consuming their API Definitions. Is this something in future that you may have planned?

主要语言
SCSS
星标
120
派生
49
平均合并
3 天 3 小时
30 天内合并 PR
2

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

monzo/docs 的其他 Issue

查看 monzo/docs 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。