As a user, I want to be able to reference the API documentation without installing or running the application
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- javascript
- 领域
- api, documentation
调研方向
首先检查当前如何公开 REST API 文档，并调查 Swagger UI 的 HTML、CSS 和 JavaScript 是否可以托管在 GitHub Pages 上供公众访问。评估从 Master 进行 CI 部署，以及单独托管交互式 "try it out" 控件的影响。当有记录在案的公共超链接可用，或证明该方案不可行时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
[Additionally], as a developer of the ATT&CK Workbench REST API I want to be able to share hyperlinks to the API documentation with users of the REST API when they ask questions about the APIs.
We should determine if it is possible to host the REST API documentation somewhere publically for ease of reference.
One possible approach is to pull the Swagger UI's HTML/CSS/JS and host that on GitHub pages, possibly with some sort of CI-deployment system to deploy the docs when pushed to Master. However, the Swagger UI does include interactive elements (i.e the "try it out" buttons) which may invalidate that approach.
- 主要语言
- JavaScript
- 星标
- 56
- 派生
- 18
- 平均合并
- 21 小时 14 分钟
- 30 天内合并 PR
- 10
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
mitre-attack/attack-workbench-rest-api 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
mitre-attack/attack-workbench-rest-api#513 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
mitre-attack/attack-workbench-rest-api#505 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
mitre-attack/attack-workbench-rest-api#499 ·
维护者通常 1 天内回复
-
Add ADM validation bypass for server-controlled fields on non-compliant objects可能已有人在做 @seansica 于 15 天前认领。 未关闭
mitre-attack/attack-workbench-rest-api#517 · 已指派 1 人 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 74/100
mitre-attack/attack-workbench-rest-api#512 · 1 条评论 ·
维护者通常 1 天内回复
查看 mitre-attack/attack-workbench-rest-api 的全部 Issue
相似的 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 78/100
glossyio/traffic-monitor#264 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 88/100
micromatch/picomatch#243 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
getComputedStyle().display is "" for span, a, b, label and other inline elements instead of "inline"未关闭
难度 2/5 1-3 小时 新手友好度 76/100
capricorn86/happy-dom#2556 ·
维护者通常 1 天内回复