Import from internal git
This commit is contained in:
30
architecture/api/apis/example/example-config.json
Normal file
30
architecture/api/apis/example/example-config.json
Normal file
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"javaGroup" : "com.example",
|
||||
"modelSuffix" : "Dto",
|
||||
|
||||
"packageTypes" : {
|
||||
"dotnet": ["server", "common", "client"],
|
||||
"java": ["server"],
|
||||
"javascript": ["server"]
|
||||
},
|
||||
|
||||
"packages" : [
|
||||
{
|
||||
"priority" : -1,
|
||||
"name" : "example",
|
||||
"type": "api",
|
||||
"dotnetPackage" : "Example.API",
|
||||
"javascriptPackage" : "ExampleAPI",
|
||||
"keepModels" : false
|
||||
},
|
||||
{
|
||||
"priority" : 1,
|
||||
"name" : "example-schemas",
|
||||
"type": "model",
|
||||
"dotnetPackage" : "Example.Common",
|
||||
"javascriptPackage" : "ExampleAPI",
|
||||
"keepModels" : true
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
22
architecture/api/apis/example/example-params.yaml
Normal file
22
architecture/api/apis/example/example-params.yaml
Normal file
@@ -0,0 +1,22 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
version: "1.0.0"
|
||||
title: 'Parameters for example'
|
||||
description: 'Defines all the parameters used in example API'
|
||||
|
||||
paths:
|
||||
/fake_path_required_for_generation:
|
||||
get:
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
components:
|
||||
parameters:
|
||||
exampleId:
|
||||
name: exampleId
|
||||
description: the id of an example
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
$ref: "example-schemas.yaml#/components/schemas/Example"
|
||||
34
architecture/api/apis/example/example-paths.yaml
Normal file
34
architecture/api/apis/example/example-paths.yaml
Normal file
@@ -0,0 +1,34 @@
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
version: "1.0.0"
|
||||
title: 'Path Items for example'
|
||||
description: 'Defines all the path items used in the example API'
|
||||
|
||||
tags:
|
||||
- name: Example
|
||||
|
||||
components:
|
||||
pathItems:
|
||||
GetExampleById:
|
||||
get:
|
||||
parameters:
|
||||
- $ref: "example-params.yaml#/components/parameters/exampleId"
|
||||
tags:
|
||||
- Example
|
||||
summary: "Get example associated with this id"
|
||||
operationId: GetExampleById
|
||||
responses:
|
||||
200:
|
||||
description: "The example associated with this id"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: 'example-schemas.yaml#/components/schemas/Example'
|
||||
400:
|
||||
description: 'The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).'
|
||||
403:
|
||||
description: 'Forbidden: the server is refusing action, you do not have the necessary permissions this resource'
|
||||
500:
|
||||
description: 'The server encountered an unexpected condition which prevented it from fulfilling the request'
|
||||
28
architecture/api/apis/example/example-schemas.yaml
Normal file
28
architecture/api/apis/example/example-schemas.yaml
Normal file
@@ -0,0 +1,28 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
version: "1.0.0"
|
||||
title: 'Schemas for example'
|
||||
description: 'Defines all the schemas used in example API'
|
||||
|
||||
paths:
|
||||
/fake_path_required_for_model_generation:
|
||||
get:
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
components:
|
||||
schemas:
|
||||
Example:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
example: "b1e0773f-ef0c-43cf-a1df-52d17f4a3017"
|
||||
name:
|
||||
nullable: false
|
||||
type: string
|
||||
description:
|
||||
nullable: true
|
||||
type: string
|
||||
20
architecture/api/apis/example/example.puml
Normal file
20
architecture/api/apis/example/example.puml
Normal file
@@ -0,0 +1,20 @@
|
||||
@startuml
|
||||
!startsub Definition
|
||||
package example {
|
||||
[Example.API]
|
||||
[Example.Common]
|
||||
[Example.Spec1.Schemas]
|
||||
[Example.Spec2.Schemas]
|
||||
}
|
||||
!endsub
|
||||
!startsub Using
|
||||
[Example.API] --> [Example.Spec1.Schemas]
|
||||
[Example.API] --> [Example.Spec2.Schemas]
|
||||
[Example.Spec1.Schemas] --> [Example.Common]
|
||||
[Example.Spec2.Schemas] --> [Example.Common]
|
||||
[Example.Common] --> [Example.Outer.Commons]
|
||||
!endsub
|
||||
!startsub UsedBy
|
||||
!endsub
|
||||
@enduml
|
||||
|
||||
10
architecture/api/apis/example/example.yaml
Normal file
10
architecture/api/apis/example/example.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
version: "1.0.0"
|
||||
title: 'Example API'
|
||||
description: 'Some demonstration stuff'
|
||||
|
||||
|
||||
paths:
|
||||
/example/{exampleId}/:
|
||||
$ref: "example-paths.yaml#/components/pathItems/GetExampleById"
|
||||
Reference in New Issue
Block a user