In designing API SDKs and documentation it is really annoying to put a whole lot of time to design the documentation and/or designing SDKs in different languages! How do you create SDKs for C#, python, Go, .NET, etc when you are limited in resources? IT world has gone so far, that creation of SDKs for the API or creation of documentation (with great web UI) have been made automatic. No one need to interfere in between.

As well as other programs or languages it needs some specification that all needs to follow. OpenAPI is the thing!

What is OpenAPI?
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

One of the great editors for designing the spec is swagger live editor:
- https://editor.swagger.io/

The full open specification of OpenAPI 3.0:
- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md

I should again note that this is a wonderful spec and makes your life easier if you master the specification. A sample documentation of OpenAPI is Alopayk:
- https://docs.alopeyk.com/

#openapi #swagger #spec #restful #api #alopayk