apidays Paris 2024 - Design, Debug, Test and Mock APIs with Kong Insomnia, Pierre-Alexandre Loriot

Design, Debug, Test and Mock APIs with Kong Insomnia
Pierre-Alexandre Loriot, Senior Solutions Engineer at Kong

apidays Paris 2024 - The Future API Stack for Mass Innovation
December 3 - 5, 2024

------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

Transcript

1. 1 Design, Debug, Test & Mock APIs with Pierre-Alexandre Loriot - Solutions Engineer
2. 2 API Lifecycle
3. 3 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Preview Test Analyze Operate Publish Deploy Design Design the API Specification Design Automate the testing & debugging of APIs Mock, Debug & Test Deploy & secure your APIs declaratively Secure & Package Publish your APIs as products. Ship & Engage Manage and Operate your APIs. Govern Review API consumption and operational metrics Analyze 3 Collaborate with API Consumers early Collaborate The API Lifecycle
4. 4 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Mock Test Analyze Operate Publish Deploy Design Design the API Specification Design Collaborate with API Consumers early Collaborate Automate the testing & debugging of APIs Mock, Debug & Test Deploy & secure your APIs declaratively Secure & Package Publish your APIs as products. Ship & Engage Manage and Operate your APIs. Govern Review API consumption and operational metrics Analyze Insomnia Insomnia Insomnia decK Inso CLI The API Lifecycle with Insomnia
5. 5 Design / Debug / Test / Mock
6. 6 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Streamline API Design • Edit OpenAPI Specifications • Real time Linting Powered by Spectral • Custom Linting Options • Rendered Specification Preview • Parsed Specification Navigation
7. 7 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) API Debugging and Testing • Import and Create Collections • Multi-Protocol Support • Manage execution and generate code • Automatic Testing Collection Generation • Define Tests • Test Suites Management • Collection Runner
8. 8 Pre request / After response scripts • Automate Repetitive Tasks • Handle complex API scenarios • Custom Behavior Before and After Responses • Built-In Testing Capability • Multi-Request Orchestration
9. 9 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Collection Runner • Run multiple requests in a row • Run as many iterations as wanted • Execute all pre- and post-requests • Summarize the overall test-results • Also available in the CLI
10. 10 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Environment variables Manage environment variables as you wish: • Global • Folder • Sub environment • Base environment Unlimited environment variables: • Leverage them in pre/post scripts • Security first: shared or privates variables • Private variables are never shared outside your local computer
11. 11 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Faker support Dynamically assign a value to a query string or body parameter for inserting randomized credible data values in collections. Choose from a large variety of use cases like: • Leverage them in pre/post scripts • Randomized names, usernames, and emails • Randomized phone numbers and street names • Randomized URLs to actual images • Randomized bank account information • Randomized sentences • And more
12. 12 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) API Mocking API mocks for collections Create visual API mocks to unblock developers. Ship faster while reducing any unnecessary team coordination. Auto-generation Upload an OpenAPI spec to automatically create API mocks, or generate them from API responses. Locally or in the cloud Run a self-hosted API mock server in your infrastructure, or easily publish it to the cloud.
13. 13 Storage Options
14. 14 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Local Vault Insomnia data is stored locally (not in the Insomnia Cloud). This option is ideal for users who prefer or require their data to remain off the cloud for privacy or security reasons. See docs for more info. Secure Cloud Insomnia data is end-to-end encrypted (E2EE) and synched securely to the Insomnia Cloud, available for collaboration between all users in an organization. This feature is beneficial for collaboration, providing easy access to projects from different devices and locations See docs for more info. When creating a Project, a storage option must be selected by the Owner or organization Admin. Git Sync Insomnia Data (in the Insomnia Cloud or Local Vault) can be synchronised with GitHub to benefit from Git features such as Git workflows. This is option recommended for APIOps and collaboration especially if Local Vault is selected. See docs for more info. Insomnia data can be synchronised to Git to benefit from Git workflows. + or Insomnia Storage Options Insomnia offers various storage options to manage Specs, Tests, Collections and Environments
15. 15 Governing Insomnia Storage Options Insomnia now allows the Enterprise Owner to set the available Storage Option for an Organisation Cloud Sync & Local Vault Cloud Sync Only Local Vault Only
16. 16 Git integration Insomnia encourages DevOps and APIOps best practices by syncing to Git for version control & collaboration ! Once repository is configured you can: • Commit • Pull • Push • Fetch • Manage branches • Access history
17. 17 93% of use cases use 3 or more AI model providers Source: Microsoft Ignite (2024) Import existing collections Insomnia supports importing and exporting: • Insomnia • Postman • HAR • OpenAPI • Swagger • WSDL • cURL Insomnia supports industry standard such as Open API Specifications (OAS v2 and v3), SOAP, GraphQL, gRPC, WebSockets, Async/Event Streams and more to come !
18. 18 User Authentication
19. 19 User Authentication Invite Users • Local Scratch Pad • Sign Up • Social Login • SSO
20. 20 Takeaway
21. 21 Takeway Getting Started Simple guide for developers on how to get started with Insomnia including training links, onboarding, etc,. Collaboration Guidelines on how to collaborate using Insomnia including setup of GitSync as part of an APIOps pipeline. Designing APIs Guidelines on how to create or import an API Specification based on API Best Practices as per your Standards. Using Collections Guidelines on using Collections and Environments in Insomnia to debug requests and responses. Testing APIs Guidelines on how to create test suites in Insomnia to unit test APIs. Governance Step by step guide on using standard APIOps pipeline to deploy APIs and create custom linting in projects as well as apply global linting. Plugins How to use Kong Plugins. Migration Guidelines and tools to migrate collections from other solutions to Insomnia. Setup the API Developer Standards Portal.
22. 22 Thank you !