OpenAPI vs Swagger






Most of the people think Swagger and openAPI is same. But, it is not.
Then what are those.

It is true that, until 2015, openAPI specification is called as Swagger specification. But, in 2015, SmartBear donated the fostering of openAPI to openAPI initiatives. Hence, since 2015, this specification was renamed to the OpenAPI specification. 
https://smartbear.com/news/news-releases/smartbear-launches-open-api-initiative-with-key-in/

Then let me explain the difference between openAPI and Swagger.

What is OpenAPI?

OpenAPI is a standard specification which can be used to describe your REST API including,
  • All the endpoints defined in your Rest API   
  • Operations defined on each endpoint
  • Operation parameters (input and output parameters)
  • Request bodies
  • Response bodies
  • Authentication Methods (Basic, OpenID)
  • License Information, terms of use
This openAPI specification can be written in both YAML and JSON.

These specifications can be understood by both human and computers  and it allows them to understand the capabilities of your REST API without observing the source codes and other documentation.

OpenAPI GitHub - https://github.com/OAI/OpenAPI-Specification

What is Swagger?

Swagger provides open source tools those can be used to implement the openAPI specifications.
Mainly, swagger has three type of tools.

Swagger editor -  This is browser based editor and this can be used to write/edit openAPI specifications in YAML format.

Swagger UI – It renders openAPI specifications and generates nice documentation. By installing Swagger UI in same domain that your endpoints are located, you can interact with your REST API through swagger UI. (Ex: You can send Requests to REST end points through the Swagger UI)
Swagger Codegen – This allows you to implement server stubs to generate openAPI specifications for given REST APIs.

 Swagger GitHub - https://github.com/swagger-api 

OpenAPI Implementation is raised by OpenAPI Initiatives. Most popular organizations in the IT world involve for this. Ex: IBM, Microsoft, Google, etc. Swagger Implementations are lead by Smartbear which is also involving for openAPI initiatives.

Latest version of the openAPI is openAPi 3.0 and Swagger 2.0 supports for implementation of it. Swagger version 1.5 can be used for implementation of openAPI version 2.

Even though, Swagger is the most commonly used tools to implement openAPI specifications, there are variety of  other tools those support for implementation of OpenAPI specifications. https://github.com/OAI/OpenAPI-Specification/blob/master/IMPLEMENTATIONS.md. 
Hence, Swagger is not the one and only tool can be used for implementations of openAPI specifications.

The common thing of Swagger and openAPI is both of them have open source communities, so anyone can join to those communities and contribute the evolvement of openAPi specifications or Swagger.

OpenAPI : https://www.openapis.org/participate/how-to-contribute
Swagger: https://swagger.io/community/




Comments

Post a Comment

Popular posts from this blog

How to add standard and custom Metadata to PDF using iTextSharp

In a previous blog, I explained How to add custom metadata using Syncfusion library. But this package gives so many difficulties when adding metadata to pdf. Such problems are,    1. When once add custom meta data to a pdf, it does not able to change or remove those custom meta data from the pdf.    2. It does not compatible with meta data search engines. It does not show custom meta data properly when those are searched through the search engines. Due to these reasons, Syncfusion is not good library for custom meta data. But, iTextSharp provides flexible framework to deal with custom meta data as well as standard meta data for PDF. Below I have provided the source code to show usage of iTextSharp library. You can download iTextShrp.dll from here                              PdfReader pdf = new PdfReader(input_path); ...
Read more

How to set and get Metadata to image using BitmapMetadata class in C#

When images are considered, those are storing their Meta data using different types of Meta containers such as EXIF, Adobe XMP, IPTC, Photoshop Image resource and Text descriptions. This every container has their specific unique rules to encode (store) and decode (extract) Meta data. As well as these each Meta container is storing specific Meta information. Exif Meta containers are mostly storing location information and GPS (Global Positioning System) records. As well as, Adobe XMP is responsible to store Dublin core Meta data which provides standard Meta tags that can be used to describe digital objects basically and IPTC is storing Meta information about application records. Meta data extractor is mainly considering these Exif, IPTC and adobe XMP Meta containers when it is extracting Meta data from images. As well as, these different Meta data containers are considered; they are structuring Meta tags in different dir...
Read more

How to generate direct line token to start a new conversation between your own client application and bot framework in Java

You can enable the communication between your bot framework and your client application using Direct Line API. When you add your client application as a site to communicate with your bot framework through azure portal, bot framework will generate secret keys. Your client application can use these generated secret keys to authenticate direct line requests issued to your bot framework. Let me explain how we can generate token to start a  conversations between your own client and bot framework. When we send a request to direct line for generating token,  if the request is successful it will send the conversation id and token that is valid to that conversation id. If client application already has a earlier used conversation Id, you can pass that id as an input to this method for generating token. If there is no conversation id, you can pass null value.  Return type of this method is a Map to retrieve generated token and conversation Id which is valid for that to...
Read more