Conventions used

There are a number of text conventions used throughout this book.

Code in text: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: "Frontend developers will probably require a /products endpoint to enable product information to be displayed."

A block of code is set as follows:

openapi: 3.0.1
info:
  title: ToDo List API
  description: Manages ToDo list tasks
  version: '1.0'
servers:
  - url: http://localhost:5000/todolist/api

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

/carts:
    post:
    get:
        queryParameter:
            username:
    /{cartId}:
        get:
        put:

Any command-line input or output is written as follows:

npm install -g newman

Bold: Indicates a new term, an important word, or words that you see on screen. For example, words in menus or dialog boxes appear in the text like this. Here is an example: "Click on the Import button and choose the OpenAPI option."

Tips or important notes

Appear like this.