An API is a computing interface that defines the requests that can be made to retrieve, change or update information in a web server through endpoints. In this guide, we will go through some important aspects when defining your API by following the REST architecture.

The post is organized in the following sections:

  • Introduction
  • HTTP Request Methods
  • Passing Information in the Request
  • HTTP Response Status Codes
  • Endpoints Naming Guidelines
  • Example Paths, Methods, and Requests
  • Throttling
  • Security
  • Popular Languages and Frameworks
  • Conclusion & Final Thoughts

Introduction

An API will allow you to provide your users or clients an interface where they can…


In this blog post, we will go through one way of documenting your REST API using the OpenAPI 3.0 standard, Redoc, and auto-generated code snippets. In this post you will find the following sections:

  • Introduction
  • The OpenAPI 3.0 Specification
  • Redoc Integration
  • Conclusion & Final Thoughts

Introduction

An API is a computing interface that defines the requests that can be made to retrieve, change or update information in a web server through endpoints. Most of the popular websites/companies offer an API to interact with their services. Some examples that you can look for are Stripe, Google, Facebook, Twitter, Reddit, etc. …

Miguel Saraiva

Electrical and Computer Engineer working as a Software Engineer

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store