What is required to write an OpenAPI contact? - OpenAPI [2]

OpenAPI documents can be written either in JSON or in YAML format. So you will need to know how to read/write in one of this format and have a text editor.

Learn read/write

If you don't know what is JSON or YAML, please go check an online tutorial before going further.
All the OpenAPI contrat is written in one of these format, so it can be hard to work with without this knowledge.

• YAML tutorials
  • Website
    • https://www.tutorialspoint.com/yaml/index.htm
    • https://learnxinyminutes.com/docs/yaml/
  • Video
• JSON tutorials
  • Website
    • https://www.w3schools.com/js/js_json_intro.asp
    • https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON
  • Video

Text editor

Simple ones

So if you don't want to use any plugins, or wanted to start quickly, any text editor can work.

At least, use a text editor which support JSON and/or YAML format like:

• Notepad++
• Atom

If you are a dev, your IDE will support both format and you will be able to start quickly.

Swagger Editor

If you want to have something more graphic to help you, you can use the Swagger Editor. It's an online tool and will show you direcly the result and if something is wrong!

IDE

If you want to use your IDE, you can found some IDE to help you

• VSCode
  • https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
  • https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer
• IntelliJ
  • https://plugins.jetbrains.com/plugin/14837-openapi-swagger-editor
• Eclipse
  • https://marketplace.eclipse.org/category/free-tagging/swagger

When you have those elements, you are ready to start your journey to the OpenAPI world!

I hope it will help you! 🍺