You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
APIWeaver is a powerful, lightweight, and feature-rich library designed to provide comprehensive OpenAPI support in .NET
10
-
6 and newer.
9
+
APIWeaver is a powerful and lightweight library designed to provide a seamless integration of OpenAPI and Swagger UI into your .NET 6+ apps. APIWeaver supports the latest .NET 8 features and is designed to be future-proof, ensuring support for upcoming .NET and OpenAPI features.
11
10
12
-
APIWeaver is committed to long-term development, ensuring support for upcoming .NET and OpenAPI features.
13
11
14
12
## Work in progress
15
13
16
-
This project is currently in the **active development** phase, with ongoing improvements, new features and potential API
17
-
changes. Contributions of any kind are highly appreciated!
14
+
This project is currently under **active development**, with ongoing improvements, new features and potential API
15
+
changes. I encourage you to try it out and provide feedback, but please be aware that the library is not yet stable.
16
+
17
+
## Getting Started
18
+
19
+
To get started with APIWeaver, you can install the NuGet package using your preferred package manager. In most cases, the package `APIWeaver.Swagger` is the one you are looking for.
20
+
21
+
1. Install the NuGet package
22
+
```shell
23
+
dotnet add package APIWeaver.Swagger
24
+
```
25
+
26
+
2. Add the using directive to your Program.cs file
27
+
```csharp
28
+
usingAPIWeaver;
29
+
```
30
+
31
+
3. Add the following lines to your `Program.cs` file.
32
+
```csharp
33
+
builder.Services.AddApiWeaver();
34
+
35
+
// other code
36
+
37
+
if (app.Environment.IsDevelopment())
38
+
{
39
+
app.UseSwaggerUi();
40
+
}
41
+
```
42
+
43
+
That's it. You now have a fully functional Swagger UI in your application. The UI can be accessed by navigating to /swagger in your browser 🥳. A more detailed guide with more use cases can be found here.
44
+
18
45
19
46
## Contribution and Collaboration
20
47
@@ -23,5 +50,5 @@ success!
23
50
24
51
## License
25
52
26
-
Distributed under the MIT License. See LICENSE for more information.
53
+
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
0 commit comments