Download as PDF, PPTX
![swagger-node
//install
$ [sudo] npm install -g swagger
//create a project with selected framework
$ swagger project create hello-world
? Framework? (Use arrow keys)
connect
› express
hapi
restify
sails
//launch for development
swagger project start
//launch the OpenAPI doc editor
swagger project edit](https://image.slidesharecdn.com/open-api-swagger-nodejs-3-23-18-180323213110/85/Designing-APIs-with-OpenAPI-Spec-18-320.jpg)
![swagger-node
//install
$ [sudo] npm install -g swagger
//create a project with selected framework
$ swagger project create hello-world
? Framework? (Use arrow keys)
connect
› express
hapi
restify
sails
//launch for development
swagger project start
//launch the OpenAPI doc editor
swagger project edit](https://image.slidesharecdn.com/open-api-swagger-nodejs-3-23-18-180323213110/75/Designing-APIs-with-OpenAPI-Spec-18-2048.jpg)
Uploaded byAdam Paxton
Designing APIs with OpenAPI Spec
The presentation by Adam Paxton on March 23, 2018, introduces the OpenAPI Specification, a standard way to describe REST APIs that enhances design consistency and documentation. It discusses tools such as Swagger Editor, Swagger UI, and Swagger Codegen for designing, documenting, and generating API code. The session also demonstrates the use of OpenAPI with Node.js and highlights the benefits of using OpenAPI in collaborative development environments.
More Related Content
Similar to Designing APIs with OpenAPI Spec
![[WSO2Con EU 2018] OpenAPI Specification 3 - The Evolution of Swagger](https://cdn.slidesharecdn.com/ss_thumbnails/kieselhorstdenniswso2con-openapi-181114060722-thumbnail.jpg?width=600ounds&width=560&fit=bounds)
Designing APIs with OpenAPI Spec
- 1. Designing APIs withOpenAPI Spec Adam Paxton Jazzcon.tech, New Orleans March 23rd, 2018
- 2.
- 3. Overview • What isthe OpenAPI Spec? • Why use it? • Swagger Tools • Design w/ Swagger Editor • Build w/ Codegen • Documentation 😲 with Swagger UI • Demo with Node.js, Angular
- 4. Hello • Adam Paxton •Freelance Mobile App Developer polancomedia.com • Location API condesa.io Twitter: @adampax Github: adampax
- 5. Goals • We alltry to practice RESTful API design • And we all try to be consistent in our design and code • And we all try to document our API (when we get time)
- 6. Problems • Design canbe cumbersome • Especially w/ multiple people involved • Giant Google Doc, anyone? • Different opinions on implementation • Documentation is last (if at all!)
- 7. Excuses • It’s tough,Adam. I’m busy. • I forgot how I did it on the last endpoint. • It was the last dev’s fault!
- 8. The OpenAPI Specification •Standard way to describe REST APIs • Language agnostic • Readable for devs and non devs • And readable by our machine overlords
- 9. Swagger OpenAPI • Formerlyknown as Swagger specification, owned by SmartBear • 2015 - Open API Initiative (OAI) was formed • Swagger donated to OAI, renamed OpenAPI Specification (OAS) • Linux Foundation, Google, Microsoft, IBM, etc • Swagger now refers to a framework of OAS developer tools
- 10. The OpenAPI Document •How you ‘design’ your API • Contained in one or more definition files • Uses YAML or JSON • Can be validated, tested, ported OpenAPI doc in a Swagger Editor
- 11. What goes init? • API endpoints • Operations for each endpoint • Input Parameters • Responses and format • Authentication • API meta info /users GET, POST, etc /users?active=true 200: {“name”: “adam”} Basic Auth, OAuth2, etc
- 12. Swagger Tools • Offersboth Open Source and Commercial Tools • Swagger Editor - design your OpenAPI spec files • Swagger UI - documentation site generator • Swagger CodeGen - generate server stubs and client SDKs • Swagger Inspector - inspection and validation tool • Swagger Node - The module we’ll be using for the demo swagger.io
- 13.
- 14. Swagger UI • Documentationis already written! • Generate an API doc site from your OpenAPI Spec • Several open source themes available github.com/swagger-api/swagger-ui
- 15. Swagger Codegen • Generateserver stubs, client SDKs from your OpenAPI spec • API clients: ActionScript, Apex, Bash, C#, C++, Clojure, Dart Elixir, Eiffel, Go, Groovy, Haskell, Java, Kotlin, Lua, Node.js, Objective-C, Perl, PHP, PowerShell, Python, R, Ruby, Rust, Scala, Swift, Typescript • Server stubs: C#, C++, Erlang, Go, Haskell, Java, PHP, Python, NodeJS, Ruby, Scala • API documentation generators: HTML, Confluence Wiki github.com/swagger-api/swagger-codegen
- 16.
- 17. OpenAPI with Node.js •swagger-node NPM module • CLI for creating OpenAPI based Node.js projects • boilerplate API and spec definition • supports Express, Restify, Hapi, Sails, Connect • Local copy of Swagger Editor • Uses OpenAPI Spec v2.0 (v3 released in 2017) github.com/swagger-api/swagger-node
- 18. swagger-node //install $ [sudo]npm install -g swagger //create a project with selected framework $ swagger project create hello-world ? Framework? (Use arrow keys) connect › express hapi restify sails //launch for development swagger project start //launch the OpenAPI doc editor swagger project edit
- 19.