Swagger ui?

[ezeparziale]

I created all my OpenAPI schemas in version 3.1.0, and now I'm trying to generate the Swagger UI. Has anyone done this? I tried using swagger-ui-react, but I'm having trouble rendering it.

[samchungy]

Hey there, not sure we can help you without any error logs or anything else

[ezeparziale]

I created this example:

/api/openapi.json

{
   "document":{
      "openapi":"3.1.0",
      "info":{
         "title":"My API",
         "version":"1.0.0"
      },
      "paths":{
         "/jobs/{jobId}":{
            "put":{
               "parameters":[
                  {
                     "in":"path",
                     "name":"jobId",
                     "description":"A unique identifier for a job",
                     "schema":{
                        "$ref":"#/components/schemas/jobId"
                     },
                     "required":true
                  }
               ],
               "requestBody":{
                  "content":{
                     "application/json":{
                        "schema":{
                           "type":"object",
                           "properties":{
                              "title":{
                                 "type":"string",
                                 "description":"Job title",
                                 "example":"My job"
                              }
                           },
                           "required":[
                              "title"
                           ]
                        }
                     }
                  }
               },
               "responses":{
                  "200":{
                     "description":"200 OK",
                     "content":{
                        "application/json":{
                           "schema":{
                              "type":"object",
                              "properties":{
                                 "jobId":{
                                    "$ref":"#/components/schemas/jobId"
                                 },
                                 "title":{
                                    "type":"string",
                                    "description":"Job title",
                                    "example":"My job"
                                 }
                              },
                              "required":[
                                 "jobId",
                                 "title"
                              ]
                           }
                        }
                     }
                  }
               }
            }
         }
      },
      "components":{
         "schemas":{
            "jobId":{
               "type":"string",
               "description":"A unique identifier for a job",
               "example":"12345"
            }
         }
      }
   }
}

But I didn't realize that I was exporting the key document and not the content, my bad.

I finally managed to render it with swagger-ui-react without any problem.