LittleKidogo / mula_spender

Some automated forms to aid in our spending
MIT License
3 stars 0 forks source link

Provide API documentation for humans #163

Open zacck-zz opened 6 years ago

zacck-zz commented 6 years ago

Is your feature request related to a problem? Please describe. At the moment we have a nice landing page briefly explaining how a developer can plug into the API and start making calls, however features of the API have been left to the developer to discover then from the GraphQL Schema.

Describe the solution you'd like It would be awesome if we could have an example for every query and mutation on the Schema, That way a developer can explore the application and establish what they can do with it

Describe alternatives you've considered Considered leaving it up to GraphQL but undocumented APIs die very quickly

Additional context Checkout the following API Documentation suggestions https://apiary.io/how-apiary-works