Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paolo-rossi committed Feb 20, 2023
1 parent 2b29132 commit 9af37a3
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OpenAPI for Delphi - OpenAPI 3.0 generator for Delphi
# OpenAPI for Delphi - OpenAPI 3.0 for Delphi

<br />

Expand All @@ -8,14 +8,18 @@

## What is OpenAPI-Delphi

**OpenAPI-Delphi** is an OpenAPI 3.0 generator for [Delphi](https://www.embarcadero.com/products/delphi) that helps you to generate OpenAPI 3.0 documentation (in JSON) starting from plain Delphi classes. Delphi-OpenAPI uses the [Neon](https://github.com/paolo-rossi/delphi-neon) serialization library to transform the OpenAPI models from Delphi classes to JSON. Please take a look at the Demo to see OpenAPI-Delphi in action.
**OpenAPI-Delphi** is an OpenAPI 3.0 library for [Delphi](https://www.embarcadero.com/products/delphi) that helps you to generate (and load) OpenAPI 3.0 documentation (in JSON) starting from plain Delphi classes. Delphi-OpenAPI uses the [Neon](https://github.com/paolo-rossi/delphi-neon) serialization library to transform the OpenAPI models from Delphi classes to JSON and to load a OpenAPI document into a Delphi (OpenAPI) object. Please take a look at the Demo to see OpenAPI-Delphi in action.

## General Features

- Use plain Delphi classes to set the OpenAPI specification fields
- OpenAPI document generation (JSON) from a Delphi (OpenAPI) object
- OpenAPI loading and parsing into a Delphi (OpenAPI) object (:star2: new in 2.0)
- Use plain Delphi classes to set the OpenAPI specification sections & fields
- Support for JSON Schema (the OpenAPI version)
- Use 1-line code (using the [Neon](https://github.com/paolo-rossi/delphi-neon) library) to transform into the JSON document
- Validation for the OpenAPI models (todo)
- Support for Schema field recursion (:star2: new in 2.0)
- Full Support for enum of any type (:star2: new in 2.0)
- Use 1-line code (using the [Neon](https://github.com/paolo-rossi/delphi-neon) library) to transform from and to JSON documents

## Todo
- Full validation for the OpenAPI models

## TODO
- Better management of null objects (required by the OpenAPI specs)

0 comments on commit 9af37a3

Please sign in to comment.