OpenAPI Specifications
Formerly known as swagger specs
What is OpenAPI Specs
• specification for machine-readable interface
files for describing, producing, consuming, and
visualizing RESTful Web services
• Originally developed by Smartbear, now
maintained by Linux Foundation
Collection of Tools
• Swagger Editor
• Swagger Codegen
• Swagger UI
Swagger Editor
• The Swagger Editor is the
best tool for quickly getting
started with the Swagger
Specification. Design new
APIs or edit existing ones in
a powerful Editor which
visually renders your
Swagger definition and
provides real time error-
feedback
Swagger Codegen
Build and enable
consumption of your
Swagger-defined APIs in
every popular language
with Swagger Codegen by
generating server stubs and
client SDKs from your
Swagger specification.
Swagger UI
Swagger UI is the ultimate
compliment of your
Swagger specification, and
automatically generates all
the documentation
described in the Swagger
specification for visual
interaction.
Swagger Demo - PHP
Some code is available here -
https://github.com/prady00/Laravel-Swagger-
REST
Swagger Demo - Java
• Code is available here –
https://github.com/swagger-api/swagger-
samples/blob/master/java/java-jersey-
jaxrs/src/main/java/io/swagger/sample/resource/P
etResource.java
• Swagger UI for these annotations is here –
http://petstore.swagger.io/#/
Swagger with SpringBoot
• Complete example is here –
https://github.com/swagger-api/swagger-
samples/tree/master/java/java-spring-boot
Appendix : References for further studies
• Swagger with Spring/Java
– http://heidloff.net/article/usage-of-swagger-2-0-in-spring-boot-
applications-to-document-apis/
– http://www.baeldung.com/swagger-2-documentation-for-spring-rest-
api
• Swagger with Laravel/PHP
– https://github.com/prady00/Laravel-Swagger-REST
– https://www.marcoraddatz.com/en/2015/07/21/integrate-swagger-
into-laravel/
• Official Swagger website
– http://swagger.io


Open API Specifications - formerly swagger

  • 1.
  • 2.
    What is OpenAPISpecs • specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful Web services • Originally developed by Smartbear, now maintained by Linux Foundation
  • 3.
    Collection of Tools •Swagger Editor • Swagger Codegen • Swagger UI
  • 4.
    Swagger Editor • TheSwagger Editor is the best tool for quickly getting started with the Swagger Specification. Design new APIs or edit existing ones in a powerful Editor which visually renders your Swagger definition and provides real time error- feedback
  • 5.
    Swagger Codegen Build andenable consumption of your Swagger-defined APIs in every popular language with Swagger Codegen by generating server stubs and client SDKs from your Swagger specification.
  • 6.
    Swagger UI Swagger UIis the ultimate compliment of your Swagger specification, and automatically generates all the documentation described in the Swagger specification for visual interaction.
  • 7.
    Swagger Demo -PHP Some code is available here - https://github.com/prady00/Laravel-Swagger- REST
  • 8.
    Swagger Demo -Java • Code is available here – https://github.com/swagger-api/swagger- samples/blob/master/java/java-jersey- jaxrs/src/main/java/io/swagger/sample/resource/P etResource.java • Swagger UI for these annotations is here – http://petstore.swagger.io/#/
  • 9.
    Swagger with SpringBoot •Complete example is here – https://github.com/swagger-api/swagger- samples/tree/master/java/java-spring-boot
  • 10.
    Appendix : Referencesfor further studies • Swagger with Spring/Java – http://heidloff.net/article/usage-of-swagger-2-0-in-spring-boot- applications-to-document-apis/ – http://www.baeldung.com/swagger-2-documentation-for-spring-rest- api • Swagger with Laravel/PHP – https://github.com/prady00/Laravel-Swagger-REST – https://www.marcoraddatz.com/en/2015/07/21/integrate-swagger- into-laravel/ • Official Swagger website – http://swagger.io
  • 11.