Configuration
This section covers the various configuration options available for Serverpod Swagger. You can customize both the OpenAPI specification generation and the Swagger UI interface to suit your project's needs.
OpenAPI Generation
Learn how to configure the OpenAPI specification generation process, including customizing endpoint documentation, HTTP methods, and more.
Learn more →Swagger UI Options
Customize the appearance and behavior of the Swagger UI interface, including themes, layout, and interactive features.
Learn more →Authentication
Configure authentication for your API documentation, including OAuth, API keys, and JWT authentication.
Learn more →Configuration Best Practices
When configuring Serverpod Swagger for your project, consider the following best practices:
- Keep documentation up-to-date: Regenerate your OpenAPI specification whenever you make changes to your API endpoints.
- Use descriptive documentation: Provide clear and concise documentation for your endpoints, including parameters, responses, and examples.
- Organize endpoints logically: Group related endpoints together using tags to make your API documentation easier to navigate.
- Include authentication information: Document authentication requirements for your API to help users understand how to authenticate their requests.
- Provide examples: Include example requests and responses to help users understand how to use your API.
Related Topics
- Custom Schema Definitions - Define custom schemas for your API documentation
- Response Examples - Add examples to your API responses
- Examples - See practical examples of Serverpod Swagger in action
Tip: You can automate the OpenAPI specification generation process by adding it to your build pipeline or using a file watcher to regenerate the specification whenever your code changes.