Welcome to apigen.springboot, made in spain , the opensource project in Java that allows you to generate an archetype of the springboot framework using the openapi file as a mapping tool between the openapi definition and the database. Click maven to see available mvnrepository dependencies.
This repository is intended for
community use, it can be modified and adapted without commercial use. If you need a version, support or help for your enterprise or project, please contact us ๐ง [email protected]
๐ข If Apigen is part of your organization's toolkit, we kindly encourage you to include your company's name in our Adopters list. ๐ This not only significantly boosts the project's visibility and reputation but also represents a small yet impactful way to give back to the project.
Organization | Description of Use / Referenc |
---|---|
CloudAppi | Apification and generation of microservices |
Acciona | Generation of microservices |
Madrid Digital | Generation of microservices |
Apiquality | Generation of microservices |
We're an inclusive and open community, welcoming you to join our effort to enhance ApiAddicts, and we're excited to prioritize tasks based on community input, inviting you to review and collaborate through our GitHub issue tracker.
Feel free to drop by and greet us on our GitHub discussion or Discord chat. You can also show your support by giving us some GitHub stars โญ๏ธ, or by following us on Twitter, LinkedIn, and subscribing to our YouTube channel! ๐
version: "3.3"
services:
apigen:
image: "apiaddicts/apitools-apigen:0.2.1"
ports:
- "8080:8080"
x-apigen-project:
name: string
description: string
version: string
java-properties:
group-id: string
artifact-id: string
x-apigen-project
: Section where project information is definedname
: Project namedescription
: Brief project descriptionversion
: Project versionjava-properties
: Section where specific Java project information is definedgroup-id
: Initial package name where the project resides. If it consists of multiple words, they will be separated by.
artifact-id
: Identifier name for the project
x-apigen-project:
name: Colors
description: This would be the Colors project
version: 1.0.0
java-properties:
group-id: the.group
artifact-id: app
x-apigen-models:
<model_name>:
relational-persistence:
table: string
attributes:
- name: string
type: string [ENUM[Array, String, Boolean, Double, Float, Integer, Long, LocalDate y OffsetDateTime, ComposedID] o <model_name>]
items-type: string [<model_name>]
relational-persistence:
column: string
primary-key: boolean
foreign-column: string
intermediate-table: string
owner: boolean
validations:
- type: string [ENUM[NotNull, Size, Min, Max, Email, NotEmpty, NotBlank, Positive, PositiveOrZero, Negative, NegativeOrZero, Past, PastOrPresent, Future, FutureOrPresent, Pattern, Digits, DecimalMin, DecimalMax]]
min: integer
max: integer
regex: string
value: integer | string
integer: integer
fraction: integer
inclusive: boolean
x-apigen-models
: Section where project models are defined<model_name>
: Name of the modelrelational-persistence
: Section where all aspects related to the model's relational persistence are indicatedtable
: Name of the table in the database
attributes
: Section that contains the model's attributesname
: Name of the attributetype
: Type of the attribute, supported types are: [Array, String, Boolean, Double, Float, Integer, Long, LocalDate, OffsetDateTime, ComposedID], or in the case of another model, the name of that modelitems-type
: In the case of thetype
being anArray
, this field should be defined with the name of the referenced modelattributes
: Similar to theattributes
of the model, only used when thetype
is ComposedID to indicate the attributes that make up the identifierrelational-persistence
: Section where all aspects related to the relational persistence of the model's attribute are indicatedcolumn
: Name of the column in the databasecolumns
: Relationship of columns from the current table to another related table when dealing with a model with a composite identifier (each entry is defined as key: value where the key is the name in the current table and the value is the name in the related table)primary-key
: Indicates if it is the primary key, if not specified, the default value will befalse
foreign-column
: Indicates the name of the column in the related tableforeign-columns
: Relationship of columns in the related table to the current table when dealing with a model with a composite identifier (each entry is defined as key: value where the key is the name in the related table and the value is the name in the current table)intermediate-table
: Name of the intermediate table in those attributes that represent a many-to-many relationshipowner
: Indicates if this part of the relationship is the owner, necessary in one-to-one or one-to-many relationshipssequence
: Section where the optional generator to use for the primary key can be indicated
validations
: Section where attribute validations are definedtype
: The supported types for validation are as follows: [NotNull, Size, Min, Max, Email, NotEmpty, NotBlank, Positive, PositiveOrZero, Negative, NegativeOrZero, Past, PastOrPresent, Future, FutureOrPresent, Pattern, Digits, DecimalMin, DecimalMax]min
: Value used when thetype
field isSize
max
: Value used when thetype
field isSize
regex
: Value used when thetype
field isPattern
value
: Value used when thetype
field isMin
,Max
,DecimalMin
, orDecimalMax
integer
: Value used when thetype
field isDigits
, representing the maximum number of digits in the integer part of the numberfraction
: Value used when thetype
field isDigits
, representing the maximum number of digits in the decimal part of the numberinclusive
: Value used when thetype
field isDecimalMin
orDecimalMax
x-apigen-models:
Color:
relational-persistence:
table: colors
attributes:
- name: id
type: Long
relational-persistence:
column: id
primary-key: true
validations:
- type: NotNull
- name: name
type: String
relational-persistence:
column: name
validations:
- type: Pattern
regex: [A-Z]+
Composed:
relational-persistence:
table: composed
attributres:
- name: id
type: ComposedID
validations:
- type: NotNull
attributes:
- name: one
type: String
relational-persistence:
column: c_one
validations:
- type: NotNull
- name: two
type: Integer
relational-persistence:
column: c_two
validations:
- type: NotNull
paths:
<path>:
...
x-apigen-binding:
model: string
x-apigen-binding
: Section where the connection between the endpoint and the model we will use is definedmodel
: In this field, we can specify the name of the model.
paths:
/colors:
x-apigen-binding:
model: Color
schemas:
<schema>:
x-apigen-mapping:
model: string
type: object
properties:
<prop_name>:
type: string
x-apigen-mapping:
model: string
field: string
<prop_name_2>:
x-apigen-mapping:
model: string
x-apigen-mapping
: Section where all mapping data between resources and models are defined. Each attribute of an input resource, including the input resource itself, can have this section defined. If it is not defined, it is assumed to have the default values indicated in each section.model
: Name of the model that the resource or attribute represents. If not specified at the resource level, it is not considered a standard input resource.field
: Name of the model attribute to which the resource attribute will be mapped. By default, if nothing is specified, it will be mapped to an attribute with the same name if it exists; otherwise, it will be ignored. There are two specific cases in which it is mandatory to define this field:- When the name of the attribute in the resource and in the model are different:
nombre: type: string x-apigen-mapping: field: primerNombre
- When the attribute in the resource is an abbreviation of the identifier of a nested model:
color: type: string x-apigen-mapping: model: color field: valorCromatico.id
- When the name of the attribute in the resource and in the model are different:
The Apigen extension for OpenAPI forces us to take into account a series of conditions so that endpoint responses comply with the standard.
schemas:
standard_response_result:
properties:
result:
type: object
properties:
status:
type: boolean
http_code:
type: integer
errors:
type: array
items:
$ref: '#/components/schemas/standard_error'
info:
type: string
trace_id:
type: string
num_elements:
type: integer
required:
- status
- http_code
- trace_id
standard_error:
type: object
properties:
code:
type: integer
message:
type: string
schemas:
standard_response_collection_<model>:
allOf:
- $ref: "#/components/schemas/standard_response_result"
- type: object
properties:
data:
type: object
properties:
<model_plural>:
type: array
items:
$ref: "#/components/schemas/<model_resource>"
schemas:
standard_response_<model>:
allOf:
- $ref: "#/components/schemas/standard_response_result"
- type: object
properties:
data:
$ref: "#/components/schemas/<model_resource>"
schemas:
<schema>:
x-apigen-mapping:
model: string
type: object
properties:
<prop_name>:
type: string
x-apigen-mapping:
field: string
x-apigen-mapping
: Section where all mapping data between resources and models are defined. Each output resource must have this section defined.model
: Name of the model that the resource represents.field
: Name of the model attribute to which the resource attribute will be mapped.
color:
x-apigen-mapping:
model: Color
type: object
properties:
json_id:
type: integer
x-apigen-mapping:
field: id
name:
type: string
forms:
$ref: "#/components/schemas/forms"