Download as PDF, PPTX
Uploaded byBruno Pedro
API Code Generation
The document discusses tools related to API development, including Postman and API Blueprint, highlighting their functionalities like code generation and documentation. It mentions techniques for testing and using markdown syntax for documentation while showcasing the conversion between Postman collections and API Blueprint formats. The author expresses intentions for future work involving enhanced code generation and exploration of new features.
API Code Generation
- 1. Bruno Pedro 13 February2014 BarcelonaJS API Code Generation http://www.flickr.com/photos/iprozac/3609806359/
- 2. Bruno Pedro Web andCloud Computing Technologist with over ten years’ experience. CTO of GetApp. Editor at APIUX.com. http://brunopedro.com/
- 3. Summary • Postman • APIBlueprint • Code generation • Questions
- 4. Postman • Powerful HTTPclient • Chrome application • Advanced request builder • History, Collections, Authentication, Documentation, … http://www.getpostman.com/
- 5.
- 6.
- 7.
- 8.
- 9.
- 10.
- 11.
- 12. API Blueprint • WebAPI Language • Markdown syntax • Documentation + method description • Powerful tooling http://apiblueprint.org/ !
- 13. API Blueprint • Testingwith Dredd • HTML docs with aglio • Mock server with Contractor
- 14.
- 15.
- 16.
- 17. Code Generation • collection •markdown • functions
- 18. Code Generation • collection •markdown nodeunit • functions
- 19. postman2apiblueprint • Reads Postmancollection JSON • API endpoints • HTTP methods (GET, POST, etc) • Headers • Parameters • Converts to API Blueprint
- 20.
- 21. apiblueprint2nodejs • Reads APIBlueprint markdown • Uses protagonist • Converts markdown into JSON • Generates nodejs code from JSON !
- 22.
- 23. Future work • ExplorePostman Collection runner • Richer output to API Blueprint • Better code generation • Reverse operation?
- 24.