Mock Servers

Mock servers in Sideko are designed to simulate the behavior of real servers based on your OpenAPI Specification. They are essential for testing and development purposes, as they allow you to interact with your API without needing the actual implementation. Mock servers check authentication, validate request schemas, and return mock responses according to your OpenAPI Specification.

Mock servers ensure that authentication mechanisms specified in your OpenAPI Specification are adhered to. This means you can test different authentication methods (e.g., API keys, OAuth tokens) and ensure integrations handles authentication correctly.

Every request sent to a mock server is validated against the schema defined in the OpenAPI Specification. This ensures that client applications are sending requests that conform to the expected structure and data types, helping you catch errors early in the development process.

Mock servers generate responses based on the examples and schemas defined in your OpenAPI Specification. This allows you to see how your API client would handle different response scenarios, including success responses, error messages, and various edge cases.

When creating a new API Project Version, specify that you want a mock server to be turned on. The UI will show the following indicator if the Mock Server has been properly turned on.

Once your mock server is set up, you can start sending requests to it as if it were your real API server. The mock server will handle authentication, validate request schemas, and return appropriate mock responses.

By leveraging Sideko mock servers, you can ensure your API clients are well-tested and your API specifications are accurately implemented, leading to smoother development and more robust applications.