search

fedspendingtransparency / usaspending-api

Server application to serve U.S. federal spending data via a RESTful API
https://www.usaspending.gov
Creative Commons Zero v1.0 Universal
306 stars 109 forks source link

Swagger API documentation #1660

Open datocrats-org opened 5 years ago

datocrats-org commented 5 years ago

Is there any Swagger API documentation file built yet? Or is that something the API could serve us somehow? Fancy documentation and an API that knows the metadata well would assist with adopting the API. As would data mapping https://github.com/fedspendingtransparency/usaspending-api/issues/341#issue-227742736

lisaam commented 5 years ago

We apologize for the delay in addressing your inquiry during the government shutdown.

Thank you for your suggested updates to the USAspending API documentation. We have passed along your suggestion to our technical team for consideration in their ongoing documentation update efforts.

The Data Dictionary mentioned in GitHub issue 341 is available here:

https://fiscal.treasury.gov/files/data-transparency/daims-data-dictionary-v1.3.xlsx

tony-sappe commented 5 years ago

@datocrats-org and @justindbk Thank you for your interest in our API. We appreciate hearing from everyone who uses the API and how they utilize it. We are in the process of revamping our API documentation. While we have tickets in our backlog, the timeline isn't set.

Swagger is a neat tool, we're actually planning to use API Blueprint for generating docs and the contracts for automated API compliance tests. The plan is to achieve incremental updates over time as we migrate to API Blueprint markdown files and improve the process around the files (using various tools and their output for our workflows).

Feel free to track the changes over the next few months and report feedback!