Confused about where to start / Swagger vs OpenAPI naming

117 views
Skip to first unread message

Louis Mandelstam

unread,
Apr 12, 2016, 6:51:36 AM4/12/16
to Swagger
Hello,

I'm tasked with taking a client's new SMS (as in mobile text messaging) REST API from its current beta state to general availability. One of the tasks is a review of the documentation and any changes required to the published API and its associated docs before going GA. Having found Swagger, I'm looking into whether we should convert our existing documentation to a Swagger spec before launching the API, so that we can use Swagger tools for generating client libraries for our customers to use, web-based documentation, etc.

Something that has thrown me off a bit is the transition from Swagger to its new name (as Wikipedia puts it) of the OpenAPI Specification.  This initially left me with the assumption that most material still referring to "Swagger" would be older, even perhaps outdated or deprecated.

But after a day or so of browsing, it appears that I should pretty much ignore this rename, and just look for Swagger material. The OpenAPI site doesn't even seem to reference specific tools and frameworks, quite unlike the Swagger site. I think it has a bit of a vapourware feel, which appears to be a total injustice to the real state of things in Swagger-land. But perhaps I'm reading too much into Wikipedia's phrasing of Swagger having been _renamed_ to the OpenAPI Specification.

Could anyone set me straight, please?


tony tam

unread,
Apr 12, 2016, 11:48:18 AM4/12/16
to swagger-sw...@googlegroups.com
It can be considered confusing, for sure.  In general:

* The Swagger specification has been donated to the OpenAPI Initiative.  During that process, the OpenAPI Initiative (OAI) chose to _not_ take the name Swagger Specification with it.  Thus the name of the specification is now the OpenAPI Specification (OAS).
* The OAI has not yet released a new version of the specification.  Therefore the OAS and Swagger specification are synonymous(!).  You can use any reference to the Swagger Specification and OpenAPI Specification interchangeably.
* Expect the transition to OAS to be more significant after the next specification is released by the OAS technical team.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply all
Reply to author
Forward
0 new messages