Designing, Testing and Maintaining REST API with Insomnia Training
Level
beginnerDuration
16h / 2 daysDate
Individually arrangedPrice
Individually arrangedDesigning, Testing and Maintaining REST API with Insomnia Training
This workshop is designed for development teams, QA, and DevOps who design, build, or integrate with APIs. The goal of the workshop is to deliver practical skills for designing stable and clear REST APIs, testing them, and maintaining them throughout the software lifecycle. During the intensive two-day workshop (≈80% hands-on), participants will learn to use the Insomnia tool to design requests, automate tests, prepare documentation (OpenAPI), mock endpoints, and integrate with CI/CD. The training also includes a block of best practices around security, compliance, and API scalability in production environments. No prior experience with Insomnia is required — all tools and processes are covered from the basics. The training can be delivered in a closed format — its scope adapted to the technological specifics of the organization (e.g. industry, types of systems, internal API standards).
Backend and frontend developers working with APIs-
Testers and QA engineers automating integration tests
-
DevOps engineers integrating tests into CI/CD pipelines
-
Software architects responsible for the consistency and clarity of interfaces
What You Will Learn
- 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
Training Program
-
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
