search

apinf / platform

Apinf - Open source API management platform with multi proxy and protocol support
https://apinf.com/
European Union Public License 1.1
74 stars 33 forks source link

Swagger-ui validates API documentations with external server #2734

Closed xylix closed 5 years ago

xylix commented 7 years ago

When user enters their API page at apinf.io (e.g. https://apinf.io/apis/mau-lu) they can expect a private API to be private. However because of swagger-uis (the swagger rich preview functionality) default configuration, the swagger of an API is always sent to swagger.io for validation Also if an user has private API, they might want to not host it publicly. Currently the only way to provide swagger documentation for the apinf platform is via a swagger file that is publicly hosted on the web.

Swagger-UIs validation configuration should be discussed.

This feature is documented here https://github.com/swagger-api/swagger-ui#parameters parameter validatorUrl.

User story

As an API owner I expect a private apinf API to not provide my APIs informations to other parties.

Resources

The following libraries may be used to validate OpenAPI documents on the client/server, from within our codebase:

-swagger-parser

bajiat commented 7 years ago

@brylie Can you add a link to a JavaScript library that would validate the OpenAPI document on our server?

brylie commented 7 years ago

@bajiat I added links to the issue description.