0xironclad / 0xironclad/Job-Application-Tracker

Create API documentation with OpenAPI / Swagger

未關閉
#21 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation
主要語言
TypeScript
星號
0
分支
0
PR 合併指標
30 天內沒有已合併 PR

描述

Define an OpenAPI specification for the main endpoints and mount a Swagger UI or Redoc viewer at a dedicated route. Keep models in sync with the actual response shapes and include example payloads for key operations.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

首先,檢查程式碼庫中現有的 API 端點,以了解請求/回應的結構。使用 Swagger Editor 或 Redoc 等工具來起草 OpenAPI 規範,確保其與實際實作相符。然後,在專用路由(可能在伺服器設定或路由檔案中)整合一個檢視器(Swagger UI 或 Redoc)。透過執行應用程式並檢查文件路由來驗證。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
openapi
領域
api, documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
50/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。