Breaking News: Grepper is joining You.com. Read the official announcement!

Understanding the basic structure of OAS

Add Answer

Pragya Keshap answered on February 18, 2023 Popularity 1/10 Helpfulness 1/10

answer Understanding the basic structure of OAS

Understanding the basic structure of OAS

Comment

The OpenAPI definition structure can be divided into the following sections (all are keyword- and case-sensitive):

openapi (version)

info

externalDocs

servers

tags

paths

components

openapi: 3.0.3
info:
  title: Sample Ecommerce App
  description: >
    'This is a ***sample ecommerce app API***.  You can find     out more about Swagger at [swagger.io](http://swagger.io). 
    Description supports markdown markup. For example, you can     use the `inline code` using back ticks.' 
  termsOfService: https://github.com/PacktPublishing/Modern-                  API-Development-with-Spring-and-Spring-                  Boot/blob/master/LICENSE
  contact:
    email: support@packtpub.com
  license:
    name: MIT
    url: https://github.com/PacktPublishing/Modern-API-         Development-with-Spring-and-Spring-Boot/blob/master/         LICENSE
  version: 1.0.0
externalDocs:
  description: Document link you want to generate along with                API.
  url: http://swagger.io

Popularity 1/10 Helpfulness 1/10 Language whatever

Source: Grepper

Tags: oas whatever

Link to this answer
Share Copy Link

Contributed on Feb 18 2023

Pragya Keshap

0 Answers Avg Quality 2/10

Understanding the basic structure of OAS

Contents

More Related Answers

Understanding the basic structure of OAS

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.