mrin9 / openapi-viewer Goto Github PK

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:

• installation into another project/page, e.g. can I do something like SwaggerUI({dom_id: '#myDomId'}) ?
• configuration options, doesn't have to include everything but things like if there's a place I can set url used to retrieve the open api spec

Hello, thanks for the amazing project.

Probably I'm missing something really stupid.
If I use a json like "https://petstore.swagger.io/v2/swagger.json"
and I try to use the API "/store/order" that has a json body, the request is always missing the body...

Am I missing something?

How is it possible to generate a static documentation from an Open API file (all included HTML & supporting files) ?

Thanks for the awesome work!

Hello,

Nice project. I have a few questions / remarks though.

I don't think there's a symbol to show required properties when in Model tab, using body parameters ? Like there could be here for example with the red stars.

Also description for arrays is never displayed. Example of OAS3 representing the case :
"list" : { "type" : "array", "description" : "My description", "items" : { "type" : "object", "description" : "My description" } }

As is min and max items for Arrays

"list" : { "maxItems" : 1000, "minItems" : 0, "type" : "array", "description" : "My description", "items" : { "$ref" : "#/components/schemas/Item" } }

Also do you plan on implementing a global model tab with all schemas ?

Thanks again.

e.g.

MrinDoc Server: http://localhost:8080

json-url: http://www.domain.com/openapi.json

{
  "openapi": "3.0.0",
  ...
  "paths": {
    "/staffs": {
      "$ref": "./paths/staffs.json"
    }
  }
  ...
}

$ref-url: http://www.domain.com/paths/staffs.json

{
  "get": {
    ...
  }
}

Now load json-url, MrinDoc can't load the correct $ref-url, but load http://localhost:8080/paths/staffs.json

Hello! As the maintainer of openapi.tools, and as somebody works with Linux Foundation helping out in OpenAPI-land, I'm reaching out to tooling vendors to track the progress towards supporting OpenAPI v3.1, to see what roadblocks there are beyond folks just generally being busy at this ridiculous time.

OpenAPI v3.1 has a bunch of great little changes, solving problems like the the JSON Schema <!=> OpenAPI Schema Object divergence. It also fixes some other inconsistencies and duplicate ways of doing things. It's the best version and everyone should be using it, but we need tooling to catch up. Just in case folks didn't notice, or don't have resources to simplify the process, I'm here to give a friendly prod and send over some handy links.

Here are a few articles showing off the differences between OpenAPI v3.0 and v3.1.

• https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
• https://www.apimatic.io/blog/2021/09/migrating-to-and-from-openapi-3-1/
• https://nordicapis.com/whats-new-in-openapi-3-1-0/

Here are some example files which can make for handy pass/fail test cases:

https://github.com/Mermade/openapi3-examples/tree/master/3.1

If you're looking for the JSON Schema that defines a valid OpenAPI document, that'll be right over here:

https://github.com/OAI/OpenAPI-Specification/tree/main/schemas/v3.1

Currently I'm noticing generic errors when I try and use anything with openapi: 3.1.0 in it, regardless of the rest of the document. Even if its a perfectly valid 3.0 with nothing 3.1 specific in there, if I change that version number in the document it will error immediately. Perhaps a little quick win could be to focus on the schema object changes, like nullable, example, exclusiveMinimum etc. being automatically converted to their new JSON Schema counterparts, then you can worry about all webhooks and other big stuff later.

No rush, but when you're starting work on it, please update this issue so I can update openapi.tools to reflect that, and folks will have a way to subscribe for updates.

LMK if you have any questions!

Is it possible to disable all the fields for dynamic testing and make it look like a static doc?

currently, only JSON format is supported for OpenAPI spec upload.
Please add support for the more common YAML format.

Hi,

First, thanks a lot for this awesome work. It really is great.

After expanding my doc, I ended up receiving a "Oops, Error encountered while parsing the Spec" when I load it into openAPI Viewer.
When passing it through openapi-spec-validator, it sees it as valid.

I found no easy way to know what node of the json structure causes the problem. I will continue searching by removing parts of my doc progressively, but meanwhile, please find attached the doc that causes this parsing error.

openAPI.json.zip

thanks again for this great work !