« Previous 1 2 3

Swagger and OpenAPI Specification for documents

ElegantSpiceworks

Conclusions

The pages generated by the Swagger UI look pretty spartan and stand apart, at least visually, from the remaining documentation. Integration into existing online help requires a suitable redesign and major interventions. The information content also depends significantly on how extensively the provider specifies its service in the API description. Not least, the use of the Swagger UI pages is not always self-explanatory.

On the up side, the use of Swagger involves very little additional work, while facilitating access to the REST API for users or other developers. If you integrate the tools into your build process, you will benefit from constantly updated documentation, including a client SDK. Conversely, programmers can use Swagger to generate a client SDK quickly for a third-party REST API and save at least some typing. It could thus be worthwhile for all parties to take a look at Swagger and its associated tools.

Infos

  1. Swagger: http://swagger.io
  2. Swagger RESTful API document specification 2.0: http://swagger.io/specification/
  3. What is Swagger: http://swagger.io/getting-started/
  4. Jax-RS: https://jax-rs-spec.java.net
  5. Node.js: https://nodejs.org
  6. SmartBear: https://smartbear.com
  7. Open API Initiative: https://openapis.org
  8. OpenAPI Specification: https://github.com/OAI/OpenAPI-Specification
  9. Swagger Editor: http://editor.swagger.io
  10. Swagger Petstore example: http://petstore.swagger.io
  11. Watson Developer Cloud: https://watson-api-explorer.mybluemix.net
  12. Swagger codegen: https://generator.swagger.io
  13. Atlassian: https://de.atlassian.com
  14. RADAR: https://bitbucket.org/atlassian/radar
  15. Swagger Editor on GitHub: https://github.com/swagger-api/swagger-editor/releases
  16. Echo service: http://mazimi-prod.apigee.net/echo
  17. Graphical user interface in Swagger: https://github.com/swagger-api/swagger-ui/releases
  18. Swagger codegen on GitHub: https://github.com/swagger-api/swagger-codegen
  19. Swagger Core: https://github.com/swagger-api/swagger-core

« Previous 1 2 3

Buy this article as PDF

Express-Checkout as PDF
Price $2.95
(incl. VAT)

Buy ADMIN Magazine

SINGLE ISSUES
Print Issues
Digital Issues
 
SUBSCRIPTIONS
Print Subs
Digisubs
 
TABLET & SMARTPHONE APPS
Get it on Google Play

US / Canada

Get it on Google Play

UK / Australia

Related content

  • Lead Image © bowie15, 123RF.com
    Developing RESTful APIs
    The popularity of REST APIs has increased of late, not only on industry sites, but also in the framework of smaller projects. We explain why this is so and illustrate the fairly abstract architectural approach with a concrete example.
    more »
  • Lead Image © Michal Bednarek, 123RF.com
    RESTful APIs in practice
    Internet providers often market their open interfaces as RESTful, but is this true of the APIs, especially when no standard exists? We introduce some REST providers and look at how closely their API architectures reflect the REST principle.
    more »
  • Lead Image © Aleksey Mnogosmyslov, 123RF.com
    DevSecOps with DefectDojo
    The DefectDojo vulnerability management tool helps development teams and admins identify, track, and fix vulnerabilities early in the software development process.
    more »
comments powered by Disqus