Swagger UI
Swagger UI is a web-based tool that renders OpenAPI descriptions as interactive documentation for exploring and testing HTTP APIs.
Building Web APIs with ASP.NET Core
Swagger UI is a browser-based interface that displays OpenAPI descriptions and lets users interactively call documented HTTP APIs.
- How it is used
- Provides browsable API documentation and an interactive client for testing board-game API endpoints.
- How deep it goes
- Shows middleware setup, endpoint execution, bearer-token configuration, and response annotations; defers broader Swashbuckle configuration.
- Examples
- Uses a PUT seeding request, an HTTP 500 error response, and account-endpoint response samples.
- What you can do after
- Apply it via Swashbuckle to browse endpoints, execute requests, inspect responses, and supply a bearer token.
Read how Building Web APIs with ASP.NET Core explains Swagger UI →
ASP.NET Core in Action, 3e
Swagger UI is a web-based interface that visualizes an API description and enables interactive API requests.
- How it is used
- Tests and inspects OpenAPI-described ASP.NET Core endpoints through a browser-based interface, especially during local development.
- How deep it goes
- Explains middleware setup, request execution, displayed responses, authentication configuration, and practical limits without detailing UI internals.
- Examples
- Uses /swagger navigation, Try it out requests, response inspection, a 404 documentation mismatch, and bearer-token authorization.
- What you can do after
- Operate Swagger UI to explore endpoints, send parameterized requests, inspect responses, and test protected APIs with bearer tokens.
.NET in Action, Second Edition
Swagger UI is a browser-based interface that renders an API description and allows users to send test requests to the API.
- How it is used
- Provides browser-based testing of ASP.NET Core controller endpoints, including requests beyond GET.
- How deep it goes
- Walks through package installation, startup configuration, and a test request; mentions authentication capability without configuring it.
- Examples
- Uses `Program.cs` registration and a `GET /Catalog` request alongside book creation, update, and deletion endpoints.
- What you can do after
- Apply it via Swashbuckle.AspNetCore to expose Swagger UI and test controller requests from a browser.
Read how .NET in Action, Second Edition explains Swagger UI →
Related concepts
- OpenAPI specificationused by · The OpenAPI Specification is a standard, machine-readable format for describing HTTP APIs, including their operations, inputs, outputs, data structures, and security requirements.
- Swashbuckleused by · Swashbuckle is a .NET library that generates and serves OpenAPI documentation, including Swagger UI, for ASP.NET Core applications.
- swagger.jsonuses · swagger.json is a generated JSON document that describes an HTTP API according to the OpenAPI specification.
- Postmanalternative to · Postman is a software platform for constructing, sending, testing, inspecting, documenting, and collaborating on requests to web APIs.
- quarkus-smallrye-openapiproduced by · A Quarkus extension that integrates SmallRye OpenAPI to generate OpenAPI descriptions for application APIs and support development-time API exploration.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.