mrin9 / OpenAPI-Viewer

OpenApi viewer Implemented using Vue
https://mrin9.github.io/OpenAPI-Viewer/
104 stars 21 forks source link

Getting started documentation #3

Closed AarjavP closed 5 years ago

AarjavP commented 5 years ago

Looking for more documentation that is similar to swagger-ui's seen here: https://github.com/swagger-api/swagger-ui#usage

Mainly these 2 topics:

mrin9 commented 5 years ago

for now it is pretty rigid, All you can do is copy the dist folder onto your WebServers public path and then

But keep an eye on this space. I am working on <custom-element> which will be free of any frameworks to allow you to seamlessly integrate into any other page additionally will have a bunch of options for personalization such as

I am trying to wrap-up the initial beta in a months time, so documentation is talking a back seat. Will keep this issue open as documentation is in the plans

AarjavP commented 5 years ago

Alright, makes sense. This does look very promising!

mrin9 commented 5 years ago

There isn't much scope if you are trying to use this to integrate this any other Html-Doc. But checkout RapiDoc. It has some documentation and also allows you to integrate with other HTMLs. Hope that answers your concerns