I am designing an API with YAML first approach using openapi 3.0. There is a requirement to define Search API which will be A GET request and will take more than 10 values as search params.
I am using swagger codegen to generate spring boot server stubs from this YAMLs. How to define the YAMl , so that the codegen generates Multivaluemap as request parameter. Rather than having 10 different search parameters, because sonar lint will show that as a bad code.
Related
I have created an apigee API proxy using swagger file, then I modified my swagger file (I added a new endpoint) but this new endpoint doesn't display until in apigee UI until I add it manually (In conditional flows), Is there a rest API provider by Apigee or something allows us to update the endpoints in Apigee dynamically by the edit of the swagger file? and thank you
I am not sure which Apigee version you are on but the Specs menu on Apigee Edge should allow you to do this. However, this is not available on Apigee-X.
For the management API you would have to create your own script that modifies the endpoints on update.
Is there a generator to convert OpenAPI 3.0 to Swagger 2.0?
Mashery, an API gateway, requires Swagger 2.0 format on input to open endpoint.
LucyBot api-spec-converter (online version, GitHub repo, Node.js module) can convert from OpenAPI 3.0 to 2.0.
API Transformer (paid service) also claims to be able to convert OpenAPI 3.0 back to OpenAPI 2.0. It has a command-line version too.
Keep in mind that OAS3→OAS2 convertion is lossy in general, because OAS3 has features that did not exist in OAS2 (such as multiple servers, oneOf/anyOf, different schemas per media type, objects in query string parameters, cookie parameters, and others).
I needed version 2.0 for Power Automate.
When you are building some Azure Functions, try to create them in Visual Studio and enable any checkbox that is named Swagger not OpenAPI.
Now the API of your Azure Function contains the swagger.json that you can set into Power Automate Custom Connector.
So I am building a Rest API and have used a swagger YAML file to define the API.
I use the swagger editor to view the spec but how do I host / make it available for everyone in our company to browse ?
Does the swagger get bundled with the actual deployed code and then it is accessible ?
You will need to host it somewhere. Either simply as a downloadable file, or embedded in an application such as Swagger UI.
iam planning to use https://vertx.io/blog/presentation-of-the-vert-x-swagger-project/ to generate my project using swagger file.
Could you please let me know it is supported by the vertx community?
This project is abandoned. Starting from vert.x 3.4, there is an official package called vertx-web-api-contract that supports OpenAPI 3 (the evolution of Swagger 2). It doesn't include a generator but it validates the requests. There is a project coming soon that also pushes to event bus the requests incoming to vert.x web router. If you need to convert your api definition from swagger 2 to openapi 3 use mermade's openapi converter.
If you want a generator that scaffolds the project give a try to https://vertx-starter.jetdrone.xyz/
I am trying to import my Service Stack swagger.json into an Azure Api Management instance. Its failing with "One or more fields contain incorrect values:
Parsing error(s): The Swagger version specified is unknown."
It seems that Azure API Management requires Swagger 2.0 but Service Stack only outputs Swagger 1.2.
Does anybody have a work around for this? Or know when Service Stack will start supporting Swagger 2.0?
ServiceStack doesn't support Swagger 2.0, you can vote for this feature request to get notified of updates.
Swagger spec has had multiple breaking changes over the years and the latest effort seems to now be rolled into https://www.openapis.org - we're waiting until this effort matures to see if it replaces Swagger 2.0 before commencing any rewrites that support it.