Tools for RESTful APIs
4 likes•369 views
The document provides an overview of RESTful APIs, explaining their stateless nature, resource identification, and CRUD methods. It highlights tools and best practices for API development, testing, and documentation, including Swagger and API Blueprint. Additionally, it mentions the importance of collaboration between API consumers and providers and includes hiring information for the author's company.
![Swagger
"paths": {
"/meetups": {
"get": {
"description": "",
"produces": [
"application/json"
],
"parameters": [
{
"name": "tags",
"in": "query",
"description": "Tag your devfloorists",
"required": false,
"type": "array",
"items": {
"type": "string"
}
...](https://image.slidesharecdn.com/toolsforrestfulapismeetuptalk-151023093535-lva1-app6891/85/Tools-for-RESTful-APIs-16-320.jpg)
Tools for RESTful APIs
- 1. Intro to dev tools for RESTful APIs Micha Mazaheri
- 3. How to make a REST API? How to test a REST API?
- 4. REST • Back to HTTP roots (RFC 2616) • Stateless – Each request is an independent transaction • Resources – Everything is a resource identified by a URI /{meetup_slug} /{meetup_slug}/events/{id} /{meetup_slug}/events/{id}/comments • CRUD Methods GET, HEAD, OPTIONS POST, PUT, PATCH DELETE
- 5. Stay RESTful POST /ParisAPI/events/225897650/ { "name":"Paris API Rocks" } PATCH /ParisAPI/events/225897650/ { "name":"Paris API Rocks" } POST /ParisAPI/events/225897650/set-name Paris API Rocks
- 6. Hypermedia { "name":"Paris API", "organizer_id":88226292 } { "name":"Paris API", “organizer":"/ParisAPI/members/88226292/" } HATEOAS (Hypermedia as the Engine of Application State)
- 8. JSON-LD JSON for Linking Data http://json-ld.org/
- 10. HTTP Clients Playgrounds for APIs Paw
- 12. Proxy Runscope Traffic InspectorCharles HTTP Client RequestBin
- 13. Local Tunneling localhost:8080 api.mydomain.com Secure tunnels to localhost
- 14. API definition Think before writing code Contract for APIs Make consumers & providers happy together
- 15. Swagger • JSON or YAML • JSON Schema http://json-schema.org/ • Many integrations • Most popular (Github stars)
- 16. Swagger "paths": { "/meetups": { "get": { "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "tags", "in": "query", "description": "Tag your devfloorists", "required": false, "type": "array", "items": { "type": "string" } ...
- 17. Swagger Swagger UI for documentation
- 18. Swagger Swagger Editor for realtime preview
- 19. RAML
- 20. API Blueprint
- 21. API Blueprint Interactive documentation (Apiary.io SaaS)
- 22. Monitoring Tools
- 23. Runscope Radar • Cloud proxy to debug Debug staging & prod • Have assertions & tests
- 24. KONG & Galileo • KONG: extension of Nginx • Galileo: analytics for APIs
- 25. Oh and…We hire!Bring together API playgrounds & definitions Encourage best practices Collaboration platform and cool customers already… Stay Tuned
- 26. Oh and…We hire rockstars! • React or OS X genius • Passion for interfaces & beautiful code • Startup gal or guy (or cat?)