tricorder-observability / Starship

Starship: next-generation Observability platform built with eBPF+WASM
GNU Affero General Public License v3.0
164 stars 24 forks source link

Add api-server document #9

Closed zh9310 closed 1 year ago

zh9310 commented 1 year ago

Provide http api document.

This doc is for the frontend engineer, so that they can have an easier time integrate the frontend with the API server.

First write in feishu doc, and then move to markdown

oojimmy commented 1 year ago

Have we considered OpenAPI spec for this project? https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md, It will have some API spec generator tools for golang, we can use it generate API spec doc, and distribute its doc spec in this GitHub code base.

oojimmy commented 1 year ago

And OpenAPi spec has some beautiful view tools, like this https://editor.swagger.io/

nascentcore-eng commented 1 year ago

Duplicate of https://github.com/tricorder-observability/starship/issues/43