api-working-group-presentation.pdf

An overview of the Code.gov API for the GSA API working group.

Transcript

1. Sharing America’s Code 1 Code.gov
2. @froi @skfroi Froilán Irizarry Backend Engineer
3. 3 One API to share them all
4. 4 GSA/code-gov-api
5. Endpoints • /repos • /repos/:id • /terms • /languages • /status.json • /docs • /agencies • /repo.json • /status • /status/:agency/issues • /status/:agency/fetched • /status/:agency/discovered
6. Repos https://api.code.gov/repos?agency.acronym=NASA& api_key=DEMO_KEY https://api.code.gov/repos?size=10&from=100& api_key=DEMO_KEY https://api.code.gov/repos?q=rest api& api_key=DEMO_KEY https://api.code.gov/repos/gsa_18f_rugged_devops? api_key=DEMO_KEY https://api.code.gov/repos?api_key=DEMO_KEY 6
7. https://api.code.gov/terms?api_key=DEMO_KEY https://api.code.gov/terms?term=NASA& api_key=DEMO_KEY https://api.code.gov/terms?size=10&from=100& api_key=DEMO_KEY Terms 7
8. Swagger Docs https://api.code.gov/docs 8
9. 9 How Does Code.gov Work? Agency 3 code.json Agency 2 code.json Agency 1 code.json harvest index validate format internet API
10. express Our Tech Stack 10
11. Why? 11 express
12. 12 Why?
13. 13 License
14. GSA API Standards 14
15. https://developers.code.gov 15
16. What we have embraced • Always HTTPS • Use API key (YAY api.data.gov!) • Just use JSON • We eat our own dog food • We have CORS enabled • We use GSA’s API Documentation Template 16
17. What we haven’t embraced 17 • Versioning in the URL • Pagination (sort of) • Proper error handling
18. Follow us @Codedotgov Join us at GSA/code-gov Get In Touch With Us Email us code@gsa.gov