Skip to content

Commit c1c8b92

Browse files
committed
[edit] readme, dictionary
1 parent 5e64312 commit c1c8b92

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"cSpell.words": [
3-
"cref"
3+
"cref",
4+
"Swashbuckle"
45
]
56
}

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,15 @@
1212

1313
## Quick Start
1414

15-
1. Add `Swashbuckle.AspNetCore.SwaggerGen` and `Swashbuckle.AspNetCore.SwaggerUI` packages to your project
15+
1. Add `Simplify.Web.Swagger`, `Swashbuckle.AspNetCore.SwaggerGen` and `Swashbuckle.AspNetCore.SwaggerUI` packages to your project
1616

17-
1. Add `AddSimplifyWebSwagger` in `AddSwaggerGen` registration and `Simplify.Web` controllers will be scanned when generation Swagger.
17+
```xml
18+
<PackageReference Include="Simplify.Web.Swagger" Version="0.1.*" />
19+
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="6.3.*" />
20+
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="6.3.*" />
21+
```
22+
23+
1. Add `AddSimplifyWebSwagger` in `AddSwaggerGen` registration and `Simplify.Web` controllers will be scanned during Swagger generation process.
1824

1925
```csharp
2026
var builder = WebApplication.CreateBuilder(args);
@@ -23,7 +29,7 @@ builder.Services.AddEndpointsApiExplorer()
2329
.AddSwaggerGen(x => x.AddSimplifyWebSwagger());
2430
```
2531

26-
3. Use swagger as in regular ASP.NET Core project
32+
3. Use Swagger as in regular ASP.NET Core project
2733

2834
```csharp
2935
var app = builder.Build();
@@ -49,7 +55,7 @@ public class GetController : Simplify.Web.Controller
4955
}
5056
```
5157

52-
5. After application started go to <http://localhost:5000/swagger/index.html> or <http://localhost:5000/swagger/swagger.json> to see generated Swagger
58+
5. After application started go to <http://localhost:5000/swagger/index.html> or <http://localhost:5000/swagger/v1/swagger.json> to see generated Swagger
5359

5460
## Contributing
5561

0 commit comments

Comments
 (0)