Jon
Jon

Reputation: 43

OpenAPI Spec Connection Refused

I am having problem with my OpenAPI spec file. I am trying to call an exposed url to 'GET' an id but every time i port forward the service to my local and then try to send request through API document my connection is refused. I would appreciate any help. The id that i am expecting would be in JSON format. Below is my spec file

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Id Generator
servers:
   url: www.someurl.com
paths:
  /posts:
    get:
      summary: Get Id
      operationId: id
      tags:
        - posts
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
              $ref: "#/definition/Post"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
              $ref: "#/definition/Error"

definition:
    Post:
    type: object 
    properties:
        id:
          type: string
    Error:
      properties:
        id:
          type: string

Upvotes: 3

Views: 3596

Answers (1)

Helen
Helen

Reputation: 97540

As of June 21 2017, OpenAPI Specification 3.0 is not out yet and Swagger UI does not support OpenAPI 3.0 yet, so your example can't possibly work. Keep an eye on Swagger UI releases page to know when support for OpenAPI 3.0 is available.

Also, you'll need to fix the errors in your spec to make it a valid OpenAPI 3.0 spec:

  • servers is an array, so change that to:

    servers:
      - url: http://www.someurl.com
    
  • Response status codes must be quoted: "200" or '200'.

  • Indent the $ref under schemas:

                  schema:
                    $ref: "#/definition/Post"
                  ...
                  schema:
                    $ref: "#/definition/Error"
    
  • Change definition to components->schemas and fix the indentation for Post:

    components:
      schemas:
        Post:
          type: object 
          properties:
            id:
              type: string
        Error:
          properties:
            id:
              type: string
    

Upvotes: 1

Related Questions