Skip to content

Swap Swagger UI to more professional Scalar UI docs#236

Draft
Copilot wants to merge 5 commits intomainfrom
copilot/integrate-chapter-1-with-scalar
Draft

Swap Swagger UI to more professional Scalar UI docs#236
Copilot wants to merge 5 commits intomainfrom
copilot/integrate-chapter-1-with-scalar

Conversation

Copy link
Contributor

Copilot AI commented Jan 24, 2026

📋 Description

Replaces Swagger UI with Scalar for professional API documentation in Chapter 1. Scalar provides a modern API reference UI with interactive testing capabilities, multi-language code snippets, and full OpenAPI 3.1 support.

Changes

  • Added Scalar.AspNetCore (v2.12.17)
  • Removed Swashbuckle.AspNetCore (redundant with native OpenAPI)
  • Updated Program.cs:
    builder.Services.AddOpenApi();
    // ...
    app.MapOpenApi();
    app.MapScalarApiReference("/docs/{documentName}");
  • Updated root redirect: /swagger/docs/v1

📦 PR Includes

  • Feature added 🆕
  • Bug fix 🐛
  • Code refactor 🔄
  • Documentation update 📚
  • Tests added/updated 🧪
  • Other: (describe)

🚫 PR Does Not Include

  • Breaking changes ❌
  • Major architectural changes 🏗️
  • Unrelated features/tasks 🚫

💡 Additional Notes

API documentation now available at /docs/v1 in development mode. Uses native Microsoft.AspNetCore.OpenApi for spec generation.

Original prompt

Create app.UseSwaggerUI();
https://scalar.com/products/api-references/integrations/aspnetcore/integration

integrate chapter 1 with scalar. Ensure that in documetation it is updaed and we are using open API. If you can add to description screnshot after and before


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@kamilbaczek
Copy link
Collaborator

@copilot use /docs

Co-authored-by: kamilbaczek <74410956+kamilbaczek@users.noreply.github.com>
@kamilbaczek
Copy link
Collaborator

@copilot remover screens from repo and .adoc file mention before after. Instead of saying we are leveraging swagger. Describe shortly in docs that we are using professional API documentation thanks to scalar and this to lib list which is also in .adc

@kamilbaczek
Copy link
Collaborator

@copilot change mr tilte to Swap Swagger UI to more professional Scalar UI docs

Copilot AI changed the title [WIP] Add Swagger UI integration and OpenAPI documentation Integrate Scalar API Reference in Chapter 1, replacing Swagger UI Jan 24, 2026
Copilot AI requested a review from kamilbaczek January 24, 2026 08:45
@kamilbaczek
Copy link
Collaborator

@copilot change base path to documentation /docs/v1 instead /scalar/v1

Co-authored-by: kamilbaczek <74410956+kamilbaczek@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 24, 2026

@copilot remover screens from repo and .adoc file mention before after. Instead of saying we are leveraging swagger. Describe shortly in docs that we are using professional API documentation thanks to...

Done in 9b82665. Removed screenshots from repo and simplified the API Documentation section to briefly describe Scalar as professional API documentation with interactive testing and OpenAPI 3.1 support.

@copilot change mr tilte to Swap Swagger UI to more professional Scalar UI docs

I cannot change the PR title directly. Please update it to: "Swap Swagger UI to more professional Scalar UI docs"

Copilot AI changed the title Integrate Scalar API Reference in Chapter 1, replacing Swagger UI Swap Swagger UI to more professional Scalar UI docs Jan 24, 2026
Co-authored-by: kamilbaczek <74410956+kamilbaczek@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 24, 2026

@copilot change base path to documentation /docs/v1 instead /scalar/v1

Done in 240b052. Changed the base path from /scalar/v1 to /docs/v1 in Program.cs, the redirect extension, and README.adoc.

@kamilbaczek
Copy link
Collaborator

@copilot ==== API Documentation

For professional API documentation, we use https://scalar.com[Scalar] - a modern API reference UI that provides interactive testing capabilities, multi-language code snippets, and full OpenAPI 3.1 support. The documentation is available at /docs/v1 in development mode.

remove

Co-authored-by: kamilbaczek <74410956+kamilbaczek@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 25, 2026

@copilot ==== API Documentation

For professional API documentation, we use https://scalar.com[Scalar] - a modern API reference UI that provides interactive testing capabilities, multi-language code...

Done in e272b44. Removed the API Documentation section from README.adoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants