API
Details | (Ordered from easiest to hardest) • Plain list of endpoints & methods that are used ◦ you can use collapsible blocks • Draw a diagram (lucidchart)Useful if service has 3+ endpoints, has non-restful interface.Can highlight what endpoint calls what sub-service / db • export postman collections • Include input payload & response examples (if swagger is not used) • Compose swagger.json manually • Compose swagger.json on the fly based on code annotations • Serve swagger.json via API based on live code & schemas • Exposed public function reference (for libraries) |
---|---|
Group | Architecture |
Priority | 2 SHOULD |