ABP Framework — API Development

Expose ABP application services as REST APIs and generate C# clients.

13|4|Updated May 27, 2026
One-click install
npx skills add https://github.com/burakdmir/abp-skills --skill abp-framework-api-development
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ABP Framework — API Development
Source: https://github.com/burakdmir/abp-skills/tree/main/claude/abp-api
Command: npx skills add https://github.com/burakdmir/abp-skills --skill abp-framework-api-development

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ABP developers need a reliable way to turn application services into REST endpoints and clients without writing repetitive controller and HTTP plumbing by hand.

Core Features & Use Cases

  • Auto API Controllers (Conventions): Automatically expose application services as REST controllers via conventional routing (e.g., method-to-HTTP mapping and route computation under /api/app by default).
  • Dynamic & Static C# HTTP Client Proxies: Generate or create runtime proxies that call remote ABP endpoints with correct serialization, auth headers, and ABP-specific metadata.
  • Swagger + API Versioning + Integration Services: Produce discoverable OpenAPI docs, support multiple API versions, and enable module-to-module integration via IIntegrationService instead of HTTP.

Use case: You build a modular ABP system where you want BookAppService endpoints exposed as REST APIs, consumed by a separate client module using generated proxies, with Swagger docs and predictable versioned routes.

Quick Start

Implement conventional API controller exposure for your ABP module and configure a client proxy so the AI can generate the required controller, routes, and HTTP client usage for API endpoints in ABP v10.4.

Frequently Asked Questions about ABP Framework — API Development

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I expose ABP application services as REST APIs without writing controllers manually?

ABP auto API controllers use conventional routing to automatically expose application services as REST endpoints under /api/app, mapping methods to HTTP verbs and computing routes without manual controller plumbing.

What is the difference between dynamic and static C# client proxies in ABP?

Dynamic C# client proxies call remote ABP endpoints at runtime, while static proxies are generated ahead of time; both handle serialization, auth headers, and ABP-specific metadata via AbpHttpClientModule and contracts assemblies.

How do I configure Swagger with JWT security and API versioning in an ABP framework project?

Swagger versioned registration with secure endpoints is configured by integrating ABP's API versioning controls and JWT security definitions, producing discoverable OpenAPI docs that support backward-compatible endpoint evolution.

Can I use IIntegrationService for module-to-module communication instead of HTTP client proxies?

Yes, ABP provides IIntegrationService to enable direct module-to-module integration without HTTP overhead, serving as an alternative to generating dynamic or static C# HTTP client proxies for internal service calls.

How does ABP route mapping work for RemoteService exposure in v10.4?

ABP v10.4 routes remote services under a /api root with module or application root path mapping, using RemoteService exposure control to determine which application services are available as REST endpoints.

What is the best way to maintain backward compatibility when versioning ABP REST APIs?

ABP API versioning allows backward-compatible endpoint evolution by configuring versioned routes and Swagger registration, ensuring existing clients continue functioning while new API versions are introduced incrementally.