REST API documentation

PdfAPI is a .NET Framework 4.6.2 ASP.NET Web API 2 service that converts, merges, and extracts pages from PDF documents, validates and inspects PDF content, and tracks the lifecycle of each processing request in an Oracle imaging schema. Callers include the generated PdfAPI.Client NuGet package and any consumer that composes the endpoint catalog directly against the deployed host.

Field	Value
Service	PdfAPI
Framework	ASP.NET Web API 2 (System.Web.Http, .NET Framework 4.6.2)
Host	IIS — Global.asax + WebApiApplication : System.Web.HttpApplication
Route configuration	PdfAPI\App_Start\WebApiConfig.cs → Register(HttpConfiguration)
Routing mode	Both — config.MapHttpAttributeRoutes() and a convention route api/{controller}/{id} (DefaultApi) are registered, but every live action carries [Route], so only attribute routing resolves any action*
Base controller	System.Web.Http.ApiController directly — no repository-local base controller exists
Versioning	[RoutePrefix("v1")] / [RoutePrefix("v1/info")] / [RoutePrefix("v1/legacy")] on 11 of 13 endpoints; ApiInfoController carries no [RoutePrefix], so GET buildVersion has no version segment
Media types	JSON only — config.Formatters.XmlFormatter removed
Composition root	PdfAPI\App_Start\IocConfig.cs (file name has a lowercase c; the class inside is IoCConfig)

Documentation sections

Section	Description
Overview	Purpose, consumers, business context, and capability summary
Architecture	Hosting, request pipeline, layering, and the DI composition root
Endpoints	Endpoint catalog with per-controller detail pages
Authentication and authorization	Identity, authorization enforcement, and role requirements
Dependencies	Libraries, packages, APIs, and database connections
Configuration	Environment API settings, runtime-resolved connections, Web.config surface
Operations and processes	End-to-end processing workflows behind the endpoints
Business rules	Rules enforced during request processing
Data model	Persistence model, entity mappings, and stored procedure usage
Operational runbook	Deployment, health checks, logs, status codes, error recovery
Tech debt	CRITICAL and HIGH severity findings

Controllers

Controller	Route prefix	Endpoints	Documentation
ConvertController	v1	2	Docs
ExtractController	v1	1	Docs
MergeController	v1	1	Docs
LegacyController	v1/legacy	1	Docs
InfoController	v1/info	7	Docs
ApiInfoController	—	1	Docs

Related documentation

• Overview
• Architecture
• Endpoints
• Authentication and authorization
• Dependencies
• Configuration
• Operations and processes
• Business rules
• Data model
• Operational runbook
• Tech debt

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.

Sources

• PdfAPI\PdfAPI.csproj
• PdfAPI\Global.asax.cs
• PdfAPI\App_Start\WebApiConfig.cs
• PdfAPI\App_Start\IocConfig.cs