eaf-api

Develops and extends EAF RESTful APIs using ASP.NET Core and ABP framework.

Updated May 8, 2026
One-click install
npx skills add https://github.com/afonsoft/EAF --skill eaf-api-afonsoft
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: eaf-api
Source: https://github.com/afonsoft/EAF/tree/main/.claude/skills/eaf-api
Command: npx skills add https://github.com/afonsoft/EAF --skill eaf-api-afonsoft

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Building RESTful APIs on the EAF (Enterprise Application Foundation) platform requires deep knowledge of ABP framework conventions, dynamic API generation, DTO patterns, and EAF-specific middleware like KeyVault, OpenTelemetry, and caching. This Skill provides expert guidance so you can implement correct, secure, and performant APIs without memorizing every ABP convention. ## Core Features & Use Cases - Dynamic API Generation: Expose Application Services as REST endpoints automatically using ABP conventions, with proper DTO design, paging, filtering, and sorting. - Security & Configuration: Implement JWT authentication, ABP permission-based authorization, Swagger/OpenAPI documentation, and CORS setup. - EAF Middleware Integration: Wire KeyVault secrets, OpenTelemetry tracing, and distributed caching into your API services. - Use Case: You need to add a new CRUD endpoint for a User entity with permission checks, paged listing, and caching. The Skill guides you through creating the Application Service, DTOs, authorization attributes, and integration tests following EAF patterns. ## Quick Start Ask the assistant to create an EAF Application Service with CRUD operations, DTOs, and permission-based authorization for your entity.

Frequently Asked Questions about eaf-api

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

FAQPage Schema
How do I create a REST API with ABP Application Services?▼

ABP automatically generates REST endpoints from Application Services, so you typically do not write Controllers. Define a class inheriting ApplicationService with methods like Create, Get, and GetAll, and ABP exposes them under /api/services/app/{service-name} routes.

How to implement paging and filtering in ASP.NET Boilerplate APIs?▼

Create an input DTO inheriting PagedAndSortedResultRequestDto with a Filter property, then apply Where clauses for filtering and PageBy for paging. Return a PagedResultDto containing TotalCount and the mapped item list.

Does ABP support JWT authentication for APIs?▼

Yes, ABP supports JWT Bearer tokens alongside cookie-based auth, Azure AD, and LDAP. You authenticate via a TokenAuthController endpoint that returns an access token, then protect endpoints with the AbpAuthorize attribute.

How do I add Swagger documentation to an ABP application?▼

Register Swashbuckle with services.AddSwaggerGen in Startup, configure the OpenApiInfo document, and enable XML comments via IncludeXmlComments. Then call UseSwagger and UseSwaggerUI in the Configure method to expose the documentation UI.

When should I write a Controller instead of an Application Service in ABP?▼

Use Application Services for standard CRUD and business operations since ABP generates endpoints automatically. Write explicit Controllers only for non-standard HTTP concerns like file uploads, custom routing, or authentication endpoints such as TokenAuthController.