MerginMaps / MerginMaps/docs

Include dev API in docs

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

还没有人认领这个 Issue。

cloud/server
主要语言
Vue
星标
15
派生
22
平均合并
5 天 11 小时
30 天内合并 PR
9

描述

if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations

贡献指南

打开贡献指南

从这里开始

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

调研方向

该 issue 确定了公共 REST API 和一个 Swagger 定义,但没有指定文件或入口点。首先定位 API 规范和文档网站的集成点;完成的标准是以便于自定义集成者使用的形式记录公共 API。

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

评估

技术栈
openapi
领域
api, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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