USStateDept / State-TalentMAP

A comprehensive research, bidding, and matching system to match Foreign Service employees with the right skills to available posts and positions. API Layer - https://github.com/USStateDept/State-TalentMAP-API
Other
31 stars 16 forks source link

Generate API documentation #1385

Open esgoodman opened 6 years ago

esgoodman commented 6 years ago

As a TalentMAP designer, I need way to quickly check content models and wireframes against current API calls So that I can quickly evaluate how difficult my designs will be to implement So that I can calibrate requests to developers!

Currently

We don't have easily accessible documentation outside of the code, and a recent wireframe approval session identified an area where wireframes may be calling for data that the API can't currently retrieve.

Desired

A developer generates static documentation so that designers don't have to spend time figuring out how to use Swagger UI 😉

Acceptance criteria

mjoyce91 commented 6 years ago

Spectacle example