How do I set up a basic REST endpoint with WiRL in Delphi?

Define a Delphi class with the [Path] attribute and methods with [GET] or [POST] attributes, as shown in the README example. Use the Neon library for JSON serialization, and register the resource with the WiRL engine to expose it as a web service.

WiRL vs DataSnap for building Delphi REST APIs?

WiRL is more focused on REST constraints and interoperability with JAX-RS standards, ideal for pure JSON APIs. DataSnap is a broader Embarcadero technology for data services, better suited for existing Delphi data applications with multiple protocols.

Does WiRL support authentication and authorization?

Yes, WiRL integrates with Delphi JOSE and JWT for JSON Web Token creation and validation, allowing you to implement JWT-based authentication easily. This is listed as a key feature in the README.

Can I use WiRL with FireDAC or other Delphi data access components?

WiRL can work with any Delphi data access layer; you can use FireDAC or similar components to handle data in your resource classes, then expose them as REST endpoints using WiRL attributes for routing and serialization.

How to generate OpenAPI documentation for my WiRL API?

WiRL uses the OpenAPI-Delphi submodule to automatically generate OpenAPI 3 documentation. Include this submodule in your project, and WiRL will document your attributed resources based on the annotations and code structure.

What Delphi versions are supported by WiRL?

WiRL requires Delphi versions that support attributes, typically Seattle (10) and later, as attributes are essential for defining endpoints. Check the official documentation for specific compatibility details and updates.

Open-Awesome

WiRL

Apache-2.0Pascalv4.6.0

A Delphi library for building RESTful web services with JAX-RS-like attributes and JSON serialization.

Visit Website GitHub

257 stars88 forks0 contributors

What is WiRL?

WiRL is a RESTful library for Delphi that allows developers to build web services by annotating plain Delphi objects with attributes to define REST endpoints. It solves the problem of creating interoperable REST APIs in Delphi by providing a JAX-RS-inspired framework with features like content negotiation, parameter injection, and JSON serialization.

Target Audience

Delphi developers building RESTful web services or APIs that need to interoperate with clients in other programming languages.

Value Proposition

Developers choose WiRL for its adherence to REST constraints, JAX-RS-like simplicity, and built-in support for JSON serialization, JWT, and OpenAPI documentation, making it a comprehensive solution for Delphi-based REST development.

Overview

WiRL: RESTful Library for Delphi

Use Cases

Best For

Building RESTful web services in Delphi with JSON APIs
Creating interoperable APIs for clients in multiple languages
Developing attribute-based REST endpoints in Delphi applications
Generating OpenAPI documentation for Delphi REST services
Implementing JWT authentication in Delphi web services
Migrating Java JAX-RS services to Delphi

Not Ideal For

Projects using older Delphi versions (pre-Seattle) that lack attribute support
Teams needing real-time communication features like WebSockets or GraphQL APIs
Developers preferring minimal-dependency frameworks or avoiding third-party submodules
Applications requiring high-performance, low-level HTTP handling without framework overhead

Pros & Cons

Pros

JAX-RS Standard Compliance

Follows Java JAX-RS specifications, providing a standardized and interoperable approach to REST development in Delphi, as emphasized in the philosophy section.

Integrated JSON and JWT

Uses the Neon serialization library for JSON and Delphi JOSE for JWT, offering built-in support for common API needs without additional setup, as listed in the submodules.

Attribute-Based Routing

Allows defining REST endpoints with attributes like Path, GET, and POST, making code declarative and easy to manage, as demonstrated in the example code snippet.

OpenAPI Documentation Generation

Automatically generates OpenAPI 3 documentation for REST services using the OpenAPI-Delphi submodule, facilitating API documentation and client integration.

Cons

Delphi Version Dependency

Requires Delphi Seattle or later for attribute support, limiting compatibility with older codebases or environments, as attributes are a key feature.

Multiple Submodule Management

Relies on three separate submodules (JOSE, Neon, OpenAPI), which can complicate installation, updates, and debugging, increasing maintenance overhead.

Niche Framework Limitations

Being specific to Delphi, it has a smaller community and fewer third-party extensions compared to cross-platform REST frameworks, potentially limiting support and integrations.

Frequently Asked Questions

Related Projects

Thrift Delphi Software Library

Apache Thrift

Stars10,942

Forks4,113

Last commit20 hours ago

DMVCFramework

DMVCFramework (for short) is a popular and powerful framework for Web API and Web Applications in Delphi. Supports RESTful and JSON-RPC WEB APIs development.

Fast, opinionated, minimalist web framework for Delphi

Stars1,362

Forks243

Last commit2 days ago

RESTRequest4Delphi

API to consume REST services written in any programming language with support to Lazarus and Delphi

Stars617

Forks178

Last commit3 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub