Skip to content
Snippets Groups Projects
Commit a22758a7 authored by Viceníková Jitka's avatar Viceníková Jitka
Browse files

Initial commit

parents
No related branches found
No related tags found
1 merge request!1Initial commit
Hide whitespace changes
Inline Side-by-side
.gitignore 0 → 100644
+ 33
− 0
View file @ a22758a7
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/
README.md 0 → 100644
+ 24
− 0
View file @ a22758a7
# Formula team management
TODO
# Pro vývoj
Nemělo by být potřeba upravovat pom.xml nikde, pouze v formula-team-management v sekci modules pro přidání nových modulů.
V openapi.yaml si nejprve specifikujte tag, který reprezentuje classu, do které se vygenerujou vaše metody např. CarService.
Tento tag pak používejte k označení metod, ať se všechny negenerujou do jedné obří classy, ale jsou pěkně rozdělené.
Vygenerování se spouští normálně pomocí:
```bash
mvn clean install
```
Pokud tam budete mít chyby, tak přepínač -e je srozumitelně vypisuje.
Appka se spustí pomocí:
```bash
cd core
mvn
```
A potom si to možete vyzkušat přes swagger na adrese http://localhost:8080/swagger-ui/index.html.
core/openapi.yaml 0 → 100644
+ 116
− 0
View file @ a22758a7
openapi: 3.0.1
info:
title: Formula team management
description: |
Hand-made OpenAPI document.
version: 1.0.0
servers:
- url: "http://localhost:8080"
tags:
- name: ComponentService
- name: CarService
components:
schemas:
Component:
type: object
title: Component
description: Component of a car
required:
- id
- weight
properties:
id:
type: integer
description: id of the component
example: 1
weight:
type: number
description: color of the component
example: 50.5
Car:
type: object
title: Car
description: Formula
required:
- id
properties:
id:
type: integer
description: Id of the car
example: 1
color:
type: string
description: Color of the car
example: 'red'
components:
type: array
description: List of components in the car
items:
$ref: '#/components/schemas/Component'
paths:
/car/get:
get:
tags:
- CarService
summary: Returns car with the given id
operationId: getCar
parameters:
- { name: id, in: query, required: true, schema: { type: integer }, description: "id of the car" }
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Car'
/car/create:
post:
tags:
- CarService
summary: creates a car
operationId: createCar
requestBody:
description: Request body for creating a new car
required: true
content:
application/json:
schema:
type: object
properties:
color:
type: string
description: The color of the car
example: "red"
minLength: 1
components:
type: array
description: List of components in the car
items:
$ref: '#/components/schemas/Component'
required:
- color
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Car'
/component/get:
get:
tags:
- ComponentService
summary: Returns component with the given id
operationId: getComponent
parameters:
- { name: id, in: query, required: true, schema: { type: integer }, description: "id of the component" }
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
core/pom.xml 0 → 100644
+ 113
− 0
View file @ a22758a7
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<!-- definition of parent Maven project -->
<parent>
<artifactId>formula-team-management</artifactId>
<groupId>cz.muni.pa165</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<!-- this module definition -->
<artifactId>core</artifactId>
<packaging>jar</packaging>
<name>Generated core</name>
<description>Core generated using OpenAPI Generator "java"</description>
<build>
<defaultGoal>spring-boot:run</defaultGoal>
<!-- name of executable JAR file -->
<finalName>core_generated</finalName>
<plugins>
<plugin>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<inputSpec>${project.basedir}/openapi.yaml</inputSpec>
<generatorName>spring</generatorName>
<apiPackage>cz.muni.pa165.generated.core.api</apiPackage>
<modelPackage>cz.muni.pa165.generated.core.model</modelPackage>
<!-- https://openapi-generator.tech/docs/generators/spring -->
<configOptions>
<basePackage>cz.muni.pa165.generated.core</basePackage>
<configPackage>cz.muni.pa165.generated.core.config</configPackage>
<useSpringBoot3>true</useSpringBoot3>
<useTags>true</useTags>
<delegatePattern>true</delegatePattern>
</configOptions>
</configuration>
</execution>
</executions>
</plugin>
<!-- create executable jar -->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<executable>true</executable>
</configuration>
</plugin>
<!-- run integration tests in "mvn verify" phase -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
</dependency>
<dependency>
<groupId>jakarta.validation</groupId>
<artifactId>jakarta.validation-api</artifactId>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-models-jakarta</artifactId>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations-jakarta</artifactId>
</dependency>
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>jackson-databind-nullable</artifactId>
</dependency>
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</dependency>
<!-- for including Swagger UI -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
<!-- for testing -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
\ No newline at end of file
core/src/main/java/cz/muni/pa165/rest/CarController.java 0 → 100644
+ 33
− 0
View file @ a22758a7
package cz.muni.pa165.rest;
import cz.muni.pa165.generated.core.api.CarServiceApiDelegate;
import cz.muni.pa165.generated.core.model.Car;
import cz.muni.pa165.generated.core.model.CreateCarRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
public class CarController implements CarServiceApiDelegate {
private static final Logger log = LoggerFactory.getLogger(CarController.class);
@Override
public ResponseEntity<Car> createCar(CreateCarRequest createCarRequest) {
log.debug("createCar() called");
return new ResponseEntity<>(
new Car()
.id(1)
.color(createCarRequest.getColor())
.components(createCarRequest.getComponents()), HttpStatus.OK);
}
@Override
public ResponseEntity<Car> getCar(Integer id) {
log.debug("getCar() called");
return new ResponseEntity<>(
new Car()
.id(1)
.components(null), HttpStatus.OK);
}
}
core/src/main/java/cz/muni/pa165/rest/ComponentController.java 0 → 100644
+ 25
− 0
View file @ a22758a7
package cz.muni.pa165.rest;
import cz.muni.pa165.generated.core.api.ComponentServiceApiDelegate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import java.math.BigDecimal;
@Component
public class ComponentController implements ComponentServiceApiDelegate {
private static final Logger log = LoggerFactory.getLogger(ComponentController.class);
@Override
public ResponseEntity<cz.muni.pa165.generated.core.model.Component> getComponent(Integer id) {
log.debug("getComponent() called");
return new ResponseEntity<>(
new cz.muni.pa165.generated.core.model.Component()
.id(1)
.weight(BigDecimal.valueOf(50.5)), HttpStatus.OK);
}
}
pom.xml 0 → 100644
+ 108
− 0
View file @ a22758a7
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<!-- parent project -->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.0.4</version>
</parent>
<!-- this project -->
<groupId>cz.muni.pa165</groupId>
<artifactId>formula-team-management</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
<name>formula-team-management</name>
<description>Formula team management</description>
<!-- modules -->
<modules>
<module>core</module>
</modules>
<!-- properties are inherited into children projects and can be used anywhere with ${property} -->
<properties>
<java.version>17</java.version>
<swagger-jakarta-version>2.2.8</swagger-jakarta-version>
</properties>
<build>
<!-- sets that "mvn" alone means "mvn install" -->
<defaultGoal>install</defaultGoal>
<!--
Sets versions of plugins for all modules in one place.
This does not include the listed plugins into modules,
modules still must be declared in each module that uses them,
just without <version>.
-->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>6.4.0</version>
</plugin>
<plugin>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-maven-plugin</artifactId>
<version>1.4</version>
</plugin>
</plugins>
</pluginManagement>
</build>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.0.2</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-text</artifactId>
<version>1.10.0</version>
</dependency>
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>jsr305</artifactId>
<version>3.0.2</version>
</dependency>
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>jackson-databind-nullable</artifactId>
<version>0.2.4</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.6.9</version>
</dependency>
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-models-jakarta</artifactId>
<version>${swagger-jakarta-version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations-jakarta</artifactId>
<version>${swagger-jakarta-version}</version>
</dependency>
<dependency>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
</dependencyManagement>
</project>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment