Arshid-Aspire-ApiDocs-Extensions

KO | EN

gitlite — search

#hacktoberfest #ai #go #golang #android #machine-learning #rust #docker #nodejs #macos #cli #kubernetes #awesome-list #pytorch

Arshid-Aspire-ApiDocs-Extensions

(★ 21)

An extension to add Swagger, OpenApi, Scalar, CustomUrl and CustomRoute to .Net Aspire.

Arshid-Aspire-ApiDocs-Extensions 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Arshid Aspire ApiDocs Extensions

[![Arshid.Aspire.ApiDocs.Extensions](https://img.shields.io/nuget/v/Arshid.Aspire.ApiDocs.Extensions.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Arshid.Aspire.ApiDocs.Extensions/)
[![Arshid.Aspire.ApiDocs.Extensions](https://img.shields.io/nuget/dt/Arshid.Aspire.ApiDocs.Extensions.svg?style=flat-square)](https://www.nuget.org/packages/Arshid.Aspire.ApiDocs.Extensions/)
[![Arshid.Aspire.ApiDocs.Extensions](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](https://raw.githubusercontent.com/zandiarash/Arshid-Aspire-ApiDocs-Extensions/Main/[https:/github.com/zandiarash/Arshid-Aspire-ApiDocs-Extensions](https:/github.com/zandiarash/Arshid-Aspire-ApiDocs-Extensions/)/blob/master/LICENSE)

</h1>
</div>

An extension to add **Swagger**, **OpenApi**, **Scalar**, **CustomUrl** and **CustomRoute** to **.Net Aspire** dashboard for **API**, **Blazor** and any other app.
You can have **ApiDocs** and also your custom **links** in your **.Net Aspire Dashboard** like this :

![AspireDashboard](https://github.com/user-attachments/assets/ab975e4e-9f42-4b93-a983-c359a2bb500c)

## Getting Started
### Installation
Simply install this **nuget package**  [Arshid.Aspire.ApiDocs.Extensions](https://www.nuget.org/packages/Arshid.Aspire.ApiDocs.Extensions) to your **AppHost.csproj**  
  
```
dotnet add package Arshid.Aspire.ApiDocs.Extensions
```

![Nuget Package](https://github.com/user-attachments/assets/824ede4b-2afd-46ae-b8cb-b24e0dacff92)

Then add these lines for the project that has Swagger, Scalar or etc.

## 📦 Example
```C#
using Arshid.Aspire.ApiDocs.Extensions;

var apiService = builder.AddProject<Projects.AspireApp1_ApiService>("apiservice")
    .WithScalar()
    .WithSwagger()
    .WithOpenApi()
    .WithCustomUrl("https://127.0.0.1:5000/CustomRoute/CustomPage1")
    .WithRoute("/CustomRoute/CustomPage2");
```

![Usage](https://github.com/user-attachments/assets/b289704b-3bb0-4cc2-ba4f-ccaafe5732f3)

## 📚 API Reference

| Method | Description | Parameters |
|--------|-------------|------------|
| `WithSwagger()` | Adds Swagger UI link | `IsHttps` (optional): Use HTTPS endpoint |
| `WithScalar()` | Adds Scalar docs link | `IsHttps` (optional): Use HTTPS endpoint |
| `WithOpenApi()` | Adds OpenAPI JSON link | `IsHttps` (optional): Use HTTPS endpoint |
| `WithCustomUrl()` | Adds custom external URL | `CustomUrl`: Full URL to open |
| `WithRoute()` | Adds custom route link | `CustomRoute`: Route path (e.g., `/health`) |

### Using HTTPS
```C#
builder.AddProject<Projects.MyApi>("api")
    .WithSwagger(IsHttps: true)
    .WithScalar(IsHttps: true);
```

## 🧪 Running Tests
```bash
dotnet test
```

## NuGet Package Statistics

| Metric | Value |
|---|---|
| **Package** | `Arshid.Aspire.ApiDocs.Extensions` |
| **Latest version** | 13.4.6.1 |
| **Total downloads** | ~5,6K |
| **Average daily downloads** | ~10 |
| **More stats** | [NuGet page](https://www.nuget.org/packages/Arshid.Aspire.ApiDocs.Extensions/) |

</div>

### If you are not familiar with Swagger, Scalar, OpenApi and similar tools please read from this article :
[net-9-revolutionizing-documentation-of-apis-from-swashbuckle-to-scalar](https://dev.to/arashzandi/net-9-revolutionizing-documentation-of-apis-from-swashbuckle-to-scalar-527)

## ⚙️ Requirements
- .NET 10.0+ (for older .NET versions install other versions of this package)
- .NET Aspire 13.x
If your project targets earlier versions, please consider using a previous release of this package.

## 🤝 Contributing
Contributions are welcome! Feel free to open a Pull Request.

## 👥 Contributors
<a href="https://github.com/zandiarash/Arshid-Aspire-ApiDocs-Extensions/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=zandiarash/Arshid-Aspire-ApiDocs-Extensions" />
</a>

Arshid-Aspire-ApiDocs-Extensions

Arshid-Aspire-ApiDocs-Extensions 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Arshid-Aspire-ApiDocs-Extensions

Arshid-Aspire-ApiDocs-Extensions 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README