API developer cookbook

Preparation

Hardware
• own notebooks
• VPN

Software
• Java - version 7, hopefully v8 will come soon
• IntelliJ IDEA or other IDE
• we use IntelliJ Idea, for Spring development we reccomend Ultimate edition (paid)
• Kong
• in a form of Vagrant box
• central OpenAPI team will provide
• VirtualBox, latest version
• Vagrant, latest version
• Git
• XMind, free edition will do (http://www.xmind.net/download/win/)
• Node.js + NPM, version 6 and newer
• all following tools will be installed automatically with base_project.zip
• Dredd - API testing
• Aglio - HTML documentation generation
• Hercule - merging documentation
• Drakov - mocking tool
• Drafter - API Blueprint parser
• (Dredd - API testing, Aglio - HTML documentation generation, Hercule - merging documentation, Drakov - mocking tool, Drafter - API Blueprint parser)
• favorite text editor (API Blueprint), one of:
• Sublime
• Atom
• VIm
• any other, but former have API Blueprint syntax highlighting
• Maven
• Cucumber

Expected knowledge (at least some of those)
• Java (ATL development)
• Spring, Spring-REST - https://spring.io/guides/gs/rest-service/
• REST APIs (in general)
• http://www.restapitutorial.com/index.html
• http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
• OAuth2 - how it works
• https://tools.ietf.org/html/rfc6749
• https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2
• DevOps
• Git - https://githowto.com/
• Jenkins - http://www.tutorialspoint.com/jenkins/
• Maven - https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html
• Analysis
• API Blueprint - https://apiblueprint.org/
• MSON - https://apiblueprint.org/documentation/mson/tutorial.html
• Design principles -
• Testing
• Dredd - https://dredd.readthedocs.io/en/latest/
• Cucumber - https://cucumber.io/
• Kong API gateway - basic principles - https://getkong.org
• Open API architecture -