[Feature Request] Run OpenAPI / Swagger Docs

[goatandsheep]

I have exported a swagger API and I'm wondering if I can use this as the README doesn't explain what this package does.

[pateketrueke]

This package will take valid json-schema sources form any given directory and then expose them as REST endpoints, su you can query them to produce random values.

Se how the server.test.js is working.

[goatandsheep]

@pateketrueke okay so to be clear, will it use the paths attribute to determine what the endpoints look like?

[pateketrueke]

It uses the filenames as endpoint paths, e.g.

$ json-schema-server path/to/schemas -p 5000
path/to/schemas/Example.json => localhost:5000/Example

[goatandsheep]

I'm going to change this to a feature request

[pateketrueke]

Please provide your input as starting point, I'm no very familiar with OpenAPI/Swagger to accomplish this by myself.

[goatandsheep]

This is the spec for OpenAPI. It has a paths object that hold the routes. Each of these paths has a set of properties set for each response code. It fits very nicely with json-schema-faker. Here's an example of a route from the link:

{
  "/pets": {
    "get": {
      "description": "Returns all pets from the system that the user has access to",
      "responses": {
        "200": {          
          "description": "A list of pets.",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/pet"
                }
              }
            }
          }
        }
      }
    }
  }
}

[goatandsheep]

The OpenAPI uses the content object and json-schema-faker uses properties. So it would have to be converted to the appropriate format, but within the properties themselves, it's the same.

[pateketrueke]

Gotcha, but I think probably there are already solutions for this.

I don't want to clutter this module just to support OpenAPI, please review here to see if something fit to your needs.

Otherwise it's possible to integrate, at least, the routing part from the spec but I'm not sure how complicated it'll be.

So much thanks for your feedback!