abp-api
/abp-api
ABP Framework v10.x (10.4–10.6) API development: Auto API Controllers, dynamic and static C#/JS client proxies, Swagger, API versioning, Integration Services. Use when you need a REST API, controller, dynamic proxy or client generation in ABP.
- Author
- burakdmir ↗
- Repository
- abp-skills ↗
- Licence
- MIT
- Last repository change
- 14.08.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 2
No signals detected. Repository changed on 14.08.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
ABP Framework v10.x (10.4–10.6) API development: Auto API Controllers, dynamic and static C#/JS client proxies, Swagger, API versioning, Integration Services. Use when you need a REST API, controller, dynamic proxy or client generation in ABP.
Original author description
ABP Framework v10.x (10.4–10.6) API development: Auto API Controllers, dynamic and static C#/JS client proxies, Swagger, API versioning, Integration Services. Use when you need a REST API, controller, dynamic proxy or client generation in ABP.
How it works
- Trigger
- Auto API Controllers
- Dynamic C Client Proxies
- Static C Client Proxies
- Swagger
- API Versioning
- Best Practices
- v10.6+
- Related
SKILL.md preview
---
name: abp-api
description: "ABP Framework v10.x (10.4–10.6) API development: Auto API Controllers, dynamic and static C#/JS client proxies, Swagger, API versioning, Integration Services. Use when you need a REST API, controller, dynamic proxy or client generation in ABP."
---
# ABP Framework — API Development
ABP Framework v10.x (10.4–10.6) API development. Auto API Controllers, Dynamic/Static C# Clients, Swagger, API Versioning.
## Trigger
- "ABP API controller"
- "ABP auto controller"
- "ABP dynamic client"
- "ABP swagger"
- "ABP API versioning"
- "ABP REST API"
## Auto API Controllers
```csharp
PreConfigure<AbpAspNetCoreMvcOptions>(options =>
{
options.ConventionalControllers.Create(typeof(BookStoreApplicationModule).Assembly);
});
```
### HTTP Method Mapping
| Prefix | HTTP |
|---|---|
| `GetList`, `GetAll`, `Get` | GET |
| `Put`, `Update` | PUT |
| `Delete`, `Remove` | DELETE |
| `Create`, `Add`, `Insert`, `Post` | POST |
| `Patch` | PATCH |
### Route Examples
| Method | Route |
|---|---|
| `GetAsync(Guid id)` | `/api/app/book/{id}` |
| `GetListAsync()` | `/api/app/book` |
| `CreateAsync(CreateBookDto input)` | `/api/app/book` |
| `UpdateAsync(Guid id, UpdateBookDto input)` | `/api/app/book/{id}` |
| `DeleteAsync(Guid id)` | `/api/app/book/{id}` |
### RemoteService
```csharp
[RemoteService(IsEnabled = false)] // Don't expose as API
public class PersonAppService : ApplicationService { }
```
## Dynamic C# Client Proxies
```bash
abp add-package Volo.Abp.Http.Client
```
```csharp
context.Services.AddHttpClientProxies(typeof(BookStoreApplicationContractsModule).Assembly);
```
```json
{ "RemoteServices": { "Default": { "BaseUrl": "http://localhost:53929/" } } }
```
```csharp
// Usage — inject the interface
var books = await _bookAppService.GetListAsync();
```
## Static C# Client Proxies
```bash
abp generate-proxy -t csharp
abp generate-proxy -t csharp --without-contracts
```
## Swagger
```csharp
context.Services.AddAbpSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
// Init
app.UseSwagger();
app.UseAbpSwaggerUI(options => options.SwaggerEndpoint("/swagger/v1/swagger.json", "v1"));
```
## API Versioning
```csharp
[ApiVersion("1.0")]
[ApiVersion("2.0")]
public class BookAppService : ApplicationService, IBookAppService { }
```
## Best Practices
1. Use Auto API Controllers — don't write controllers manually
2. Use dynamic client proxies — don't use HttpClient manually
3. Prefer static proxies in production
4. Add JWT auth in Swagger
5. Ensure backward compatibility with API versioning
## v10.6+
- API definition exposes response `ContentTypes` + `IsRemoteStream`; Angular/jQuery upload proxies send `IRemoteStreamContent` DTOs as multipart `FormData` — regenerate proxies after upgrading.
## Related
[DDD](../abp-ddd/SKILL.md) · [UI](../abp-ui/SKILL.md) · [Microservices](../abp-microservices/SKILL.md) · [Authorization](../abp-authorization/SKILL.md) · Docs: https://abp.io/docs/latest/framework/api-development
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · burakdmir/abp-skills | 100 | MIT |
| burakdmir/abp-skills | 100 | MIT |
Database snapshot: 13.11.2026 · package version e03d34b63b38 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 98abp-cli
ABP Framework v10.x (10.4–10.6) CLI and tooling: abp new, add-package, generate-proxy, ABP Studio, ABP Suite, --modern flag. Use when working with ABP CLI commands, creating projects, adding packages, or generating proxies. - 100version-http-apis
Add API versioning to ABP HTTP APIs so multiple versions of the same service coexist behind static client proxies. USE FOR: AddAbpApiVersioning, query/header/media-type version readers, attaching ApiVersions to conventional controllers, ICurrentApiVersionInfo runtime version… - 100consume-remote-services
Call a remote ABP HTTP API from C# through generated client proxies instead of raw HttpClient. USE FOR: setting up dynamic (runtime) or static (build-time) client proxies, configuring AbpRemoteServiceOptions (BaseUrl / named endpoints), wiring tiered / microservice calls,… - 98abp-cli
ABP Framework v10.x (10.4–10.6) CLI and tooling: abp new, add-package, generate-proxy, ABP Studio, ABP Suite, --modern flag. Use when working with ABP CLI commands, creating projects, adding packages, or generating proxies. - 100api-design-patterns
REST API design, versioning, error responses, pagination, OpenAPI conventions. Use when designing new API endpoints, reviewing API contracts, or setting up Swagger/OpenAPI documentation. - 100swagger-doc-creator
Create swagger doc creator operations. Auto-activating skill for API Development. Triggers on: swagger doc creator, swagger doc creator Part of the API Development skill category. Use when working with swagger doc creator functionality. Trigger with phrases like "swagger doc…