Visão Geral

Este Curso RESTful API Design, Development, and Testing using Insomnia, Insomnia ensina aos participantes os fundamentos do desenvolvimento e teste de APIs. A aula se concentra no design de APIs RESTful JSON usando OpenAPI 3 para documentação e geração de código e testes via Insomnia GUI e CLI. Observação: este curso usa o aplicativo e a CLI da Insomnia instalados via npm. Uma conta GitHub é opcional, mas incentivada.

Objetivo

Após realizar este Curso RESTful API Design, Development, and Testing using Insomnia, você será capaz de:

• Entenda o estilo arquitetônico REST e suas motivações
• Implementar design de especificação OpenAPI
• Utilize o Modelo de Maturidade de Richardson para discutir escolhas de design e propriedades induzidas
• Use o Insomnia para design, depuração e teste de API
• Entenda a representação JSON dos dados do objeto
• Incorpore abordagens de gerenciamento de API
• Implemente estratégias automatizadas de teste de CI/CD
• Pense em APIs REST versus dados vinculados, modelos RPC e GraphQL

Pre-Requisitos

• Além do desenvolvimento orientado a objetos ou experiência em arquitetura, nenhum conhecimento prévio é presumido.

Materiais

Conteúdo Programatico

Introduction

1. REST API overview
2. Previous API Concepts

JSON

1. Concepts of REST
2. HTTP
3. Nouns/Verbs

Designing an API

1. Swagger
2. Sections of Specification

OpenAPI Spec

1. Info
2. Servers

API Concepts

Richardson Maturity Model

1. Levels
2. Hypermedia

Development and Testing

1. C# and other examples
2. Tools Available

Development Standards

OpenAPI Contract

1. Paths
2. Operations

Automated Testing

1. Chai Assertion Library
2. Insomnia CLI
3. Test Suites

Versioning

1. URL
2. Header
3. Both

Security

1. Authentication
2. Authorization
3. JWT

Parameters

1. Path
2. Query String
3. Header
4. Cookie
5. Serialization

Request Bodies

Responses

Components

CI/CD Testing

1. Principles
2. Best Practices
3. Integration & Security Testing

Using Insomnia for CI/CD Testing

1. CLI
2. Github Actions