Skip to content

Update Swagger UI section in README #2883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 15, 2024
Merged

Update Swagger UI section in README #2883

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
793948b
Update README.md
cremor May 15, 2024
dbca125
Add TOC entry
cremor May 15, 2024
b5db354
Revert accidental change
cremor May 15, 2024
d832eba
Fix syntax in code snippets
cremor May 15, 2024
a0ea07f
Revert accidental change
cremor May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ The steps described above will get you up and running with minimal setup. Howeve
* [Change Document Title](#change-document-title)
* [List Multiple Swagger Documents](#list-multiple-swagger-documents)
* [Apply swagger-ui Parameters](#apply-swagger-ui-parameters)
* [Inject Custom JavaScript](#inject-custom-javascript)
* [Inject Custom ](#inject-custom-)
* [Inject Custom CSS](#inject-custom-css)
* [Customize index.html](#customize-indexhtml)
* [Enable OAuth2.0 Flows](#enable-oauth20-flows)
Expand Down Expand Up @@ -1240,7 +1240,6 @@ By default, the Swagger UI will be exposed at "/swagger". If necessary, you can
app.UseSwaggerUI(c =>
{
c.RoutePrefix = "api-docs"
...
}
```

Expand All @@ -1252,7 +1251,6 @@ By default, the Swagger UI will have a generic document title. When you have mul
app.UseSwaggerUI(c =>
{
c.DocumentTitle = "My Swagger UI";
...
}
```

Expand Down Expand Up @@ -1302,7 +1300,6 @@ To tweak the behavior, you can inject additional JavaScript files by adding them
```csharp
app.UseSwaggerUI(c =>
{
...
c.InjectJavascript("/swagger-ui/custom.js");
}
```
Expand All @@ -1318,7 +1315,6 @@ To tweak the look and feel, you can inject additional CSS stylesheets by adding
```csharp
app.UseSwaggerUI(c =>
{
...
c.InjectStylesheet("/swagger-ui/custom.css");
}
```
Expand Down Expand Up @@ -1346,8 +1342,6 @@ If your Swagger endpoint includes the appropriate security metadata, the UI inte
```csharp
app.UseSwaggerUI(c =>
{
...

c.OAuthClientId("test-id");
c.OAuthClientSecret("test-secret");
c.OAuthUsername("test-user");
Expand All @@ -1369,8 +1363,6 @@ To use custom interceptors on requests and responses going through swagger-ui yo
```csharp
app.UseSwaggerUI(c =>
{
...

c.UseRequestInterceptor("(req) => { req.headers['x-my-custom-header'] = 'MyCustomValue'; return req; }");
c.UseResponseInterceptor("(res) => { console.log('Custom interceptor intercepted response from:', res.url); return res; }");
});
Expand All @@ -1381,8 +1373,6 @@ This can be useful in a range of scenarios where you might want to append local
```csharp
app.UseSwaggerUI(c =>
{
...

c.UseRequestInterceptor("(req) => { req.headers['X-XSRF-Token'] = localStorage.getItem('xsrf-token'); return req; }");
});
```
Expand Down