Thank you for participating in the Spring Coding Challenge. We just started off the challenge with our optional kickoff meeting and brainstorming challenge. We wanted to create a thread where folks could post about the ideas for projects that they had and recruit like-minded team mates.
Why
A step-by-step guide walking developers through our API and how to work could help reduce the barrier to entry, especially for those who aren’t super familiar with reading and working with OpenAPI documentation.
What it could look like
Simple: A markdown file that explains how to call the API, provides example cURL commands (or JS or Python scripts), etc.
More complex: A static site (e.g. MkDocs, Starlight, or Jekyll that provides an extended tutorial for working with the API
Why
Having a library or software development kit (SDK) that simplifies handling API calls reduces the barrier to entry for building on top of that API. Rather than managing API tokens, pagination, and request headers manually, it would be great to have a library to abstract away working with the API.