Designing, Testing, and Maintaining REST APIs with Insomnia
This workshop is designed for development teams, QA, and DevOps who design, build, or integrate with APIs.
Ideal for teams that…
Solid backend and architecture — patterns proven in production.
How to design readable and scalable REST APIs in accordance with good practices
How to test APIs automatically using Insomnia and integrate tests into CI/CD pipelines
Principles of secure API communication: authentication, validation, access control
How to prepare and maintain API documentation (OpenAPI) and use mocks for testing and integration
What we actually do
- · Introduction to REST API What is an API and REST architecture Use-cases of APIs REST vs GraphQL vs SOAP
- · Basics of HTTP Client-server model, statelessness, caching HTTP methods: GET, POST, PUT, DELETE, PATCH Response status codes: 2xx, 4xx, 5xx HTTP headers: Content-Type, Accept, Authorization, Cache-Control Security: HTTPS, CORS JSON data format – syntax, good practices
- · Designing REST API Identifying resources RESTful URIs and good naming conventions Using HTTP methods semantically Error handling and messaging conventions Filtering, sorting, pagination, API versioning The ideal REST assumptions vs practical trade-offs
- · Getting Started with Insomnia What Insomnia is – comparison with Postman Installation and interface tour Creating requests (GET/POST etc.) Organizing workspaces and folders Importing and exporting collections
- · Working with Insomnia – Basics Parameters: query, path, headers, body (JSON) Authorization: Basic Auth, Bearer Token, OAuth2 Managing environments and variables
- · Workshop Project: User API Designing endpoints Creating Insomnia collections Sending requests, analyzing responses Simulating errors, validation tests
- · Testing APIs in Insomnia Assertions on status, headers, and data Chained/sequential requests Pre-request and post-request scripts (Insomnia Hooks) Dynamic data and environment variables
- · API Documentation OpenAPI (Swagger) – basics and integration with Insomnia Generating documentation Comments, descriptions, project structure Sharing APIs – export, shareable links, OpenAPI
- · Automation and CI Debugging and logging in Insomnia Insomnia CLI (inso) – running tests from command line CI/CD integration: GitHub Actions, GitLab CI, Jenkins Regression tests and smoke tests Mocking API (Insomnia Designer)
- · REST API Security Authentication & authorisation: Basic Auth, Token, OAuth2 Protection mechanisms: rate limiting, throttling Good practices: validation, CORS, limiting HTTP methods
- · Maintenance and Development of REST API Versioning & compatibility Deprecation and migrations Compliance tests Project organization, naming conventions, environments
- · Best & Bad Practices Real-world cases: what works and what doesn’t Readability and usability of APIs Anti-patterns and how to avoid them
- · Summary REST API checklists Recommended tools and resources Q&A session Sample project and OpenAPI file
From brief to retro in 30 days.
Brief & diagnosis
A call with the team lead + a short survey for participants. We define goals, gap and context.
Program customization
We adapt modules, case studies and code examples to your stack. Approval in 5 days.
Workshop
Trainer-led sessions, hands-on, code review. Mentor available between sessions too.
Retro + report
Outcome report for the team and lead. 30 days of consulting included.
Send a brief. We'll reply within 1 day.
After a short brief we'll prepare a program and a quote. No obligations — it's just a starting point.
Thank you!
We'll get back to you within 1 business day.
Other programs for teams
See all →Application architecture
Solid backend and architecture — patterns proven in production.
DDD
Solid backend and architecture — patterns proven in production.
Design patterns in C#
Solid backend and architecture — patterns proven in production.