Hi Thilini, Another thing we need to think about is whether we should let API developers decide which swagger version they need in their new APIs (if yes, how), or should we always use swagger 3 for new APIs. I prefer the first option unless we have any technical barriers supporting that.
Thanks. Bhathiya On Mon, Jan 8, 2018 at 7:58 PM, Thilini Shanika <[email protected]> wrote: > Hi All, > > We are planning to provide OpenAPI 3.0 specification support for API > Manager 2.2.0 [1]. We did a background research on what's new in OpenAPI > and the feasibility of providing OpenAPI 3.0 support over APIM 2.2.0. As > per the current architecture of APIM, it is feasible to support OpenAPI 3.0 > spec, parallel with Swagger 2.0 (Swagger 2.0 support is required for > migrated APIs from previous releases) > > Following are the functionalities we are planning to ship with this new > feature. > > 1. Supporting OpenAPI 3.0 spec for newly designing/Creating APIs (When > an API is created from the scratch, the underneath API definition will be > generated in OpenAPI 3.0) > 2. The API definitions of migrated APIs from previous releases are > based on Swagger 2.0 spec. Thus, Swagger 2.0 spec support will be continued > for migrated APIs > 3. Providing support to import OpenAPI 3.0 spec based API definitions > while creating an API from an existing source. > 4. Swagger editor in APIM 2.2.0 has been upgraded to 3.x version so > that it will be supporting OpenAPI 3.0 spec while updating API source via > Swagger Editor in API Publisher. > 5. Swagger UI in APIM 2.2.0 has been upgraded to 3.x version so that > API Console in API Store will be supporting OpenAPI 3.0 based API > definitions > 6. Providing the functionality of switching the gateway environment > endpoints for OpenAPI 3.0 specific APIs (If it is a Swagger 2.0 based API > definition, the relevant gateway endpoint should be specified in host, > basepath and schema elements of the Swagger definition. But in OpenAPI 3.0, > the gateway endpoint details should be specified under server element of > the definition. ) > > > Any suggestions to improve the functionalities and usability aspects of > the feature? Your comments and thoughts on this are highly appreciated. > > [1] https://github.com/wso2/carbon-apimgt/issues/4897 > > Thanks > > -- > Thilini Shanika > Senior Software Engineer > WSO2, Inc.; http://wso2.com > 20, Palmgrove Avenue, Colombo 3 > > E-mail: [email protected] > > -- *Bhathiya Jayasekara* *Associate Technical Lead,* *WSO2 inc., http://wso2.com <http://wso2.com>* *Phone: +94715478185* *LinkedIn: http://www.linkedin.com/in/bhathiyaj <http://www.linkedin.com/in/bhathiyaj>* *Twitter: https://twitter.com/bhathiyax <https://twitter.com/bhathiyax>* *Blog: http://movingaheadblog.blogspot.com <http://movingaheadblog.blogspot.com/>*
_______________________________________________ Architecture mailing list [email protected] https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
