Recognise server can be client
parent
6d82fc1723
commit
417ed7f7e4
|
|
@ -101,13 +101,13 @@ sequenceDiagram
|
|||
|
||||
term -->- vsc: close
|
||||
|
||||
rect grey
|
||||
rect lightgrey
|
||||
Note over vsc, qaskx: Developer codes to use the OpenAPI definition, with base code in place
|
||||
vsc -->> vsc: Code update
|
||||
vsc -->> vsc: Local build
|
||||
vsc -->> vsc: Local test
|
||||
end
|
||||
|
||||
|
||||
vsc ->>+ git: Commit
|
||||
git --) git: Trigger GitActions for lint, gateway, features, etc
|
||||
git ->>- vsc: Success
|
||||
|
|
|
|||
|
|
@ -24,6 +24,9 @@ The assumptions for this documents are:
|
|||
The sequence of automation activity using **devops** file and **qaskx-cli** is
|
||||
as follows.
|
||||
|
||||
**A server can also be a consumer of other APIs in which case it needs to generate
|
||||
when downstream API specifications client code.**
|
||||
|
||||
The Qaskx command line tool needs to be installed on the developer machine
|
||||
|
||||
```mermaid
|
||||
|
|
@ -94,13 +97,28 @@ sequenceDiagram
|
|||
qaskx -) devops: Auto update entries, including build, test
|
||||
qaskx -->>- term: Success
|
||||
|
||||
rect grey
|
||||
opt
|
||||
|
||||
term ->>+ qaskx: Generate code
|
||||
Note over qaskx, cmdb: qaskx-cli gen client cmd
|
||||
qaskx ->>+ devops: Read dependency list
|
||||
devops -->>- qaskx: Contents
|
||||
loop Read called dependencies
|
||||
qaskx ->>+ oas3f: Read dependency
|
||||
oas3f -->>- qaskx: Contents
|
||||
qaskx -) qaskx: Auto generate client code
|
||||
end
|
||||
qaskx -->>- term: Success
|
||||
|
||||
end
|
||||
|
||||
rect lightgrey
|
||||
Note over vsc, qaskx: Developer codes to use the OpenAPI definition, with base code in place
|
||||
vsc -->> vsc: Code update
|
||||
vsc -->> vsc: Local build
|
||||
vsc -->> vsc: Local test
|
||||
end
|
||||
|
||||
|
||||
alt Register API if not already done
|
||||
|
||||
term ->>+ qaskx: Register API
|
||||
|
|
|
|||
|
|
@ -45,6 +45,9 @@ sequenceDiagram
|
|||
Once the OpenAPI definition has been updated the server code needs to be
|
||||
re-generated as the publisher of the API.
|
||||
|
||||
**A server can also be a consumer of other APIs in which case it needs updating
|
||||
when downstream API specifications change.**
|
||||
|
||||
```mermaid
|
||||
---
|
||||
title: Server development update task flow
|
||||
|
|
@ -84,15 +87,30 @@ sequenceDiagram
|
|||
end
|
||||
qaskx -->>- term: Success
|
||||
|
||||
opt
|
||||
|
||||
term ->>+ qaskx: Generate code
|
||||
Note over qaskx, cmdb: qaskx-cli gen client cmd
|
||||
qaskx ->>+ devops: Read dependency list
|
||||
devops -->>- qaskx: Contents
|
||||
loop Read called dependencies
|
||||
qaskx ->>+ oas3f: Read dependency
|
||||
oas3f -->>- qaskx: Contents
|
||||
qaskx -) qaskx: Auto generate client code
|
||||
end
|
||||
qaskx -->>- term: Success
|
||||
|
||||
end
|
||||
|
||||
term -->- vsc: close
|
||||
|
||||
rect grey
|
||||
rect lightgrey
|
||||
Note over vsc, qaskx: Code updates to use the updated OpenAPI definition
|
||||
vsc -->> vsc: Code update
|
||||
vsc -->> vsc: Local build
|
||||
vsc -->> vsc: Local test
|
||||
end
|
||||
|
||||
|
||||
vsc ->>+ git: Commit
|
||||
git --) git: Trigger GitActions for lint, gateway, features, etc
|
||||
git ->>- vsc: Success
|
||||
|
|
@ -147,7 +165,7 @@ sequenceDiagram
|
|||
|
||||
term -->- vsc: close
|
||||
|
||||
rect grey
|
||||
rect lightgrey
|
||||
Note over vsc, qaskx: Code updates to use the updated OpenAPI definition
|
||||
vsc -->> vsc: Code update
|
||||
vsc -->> vsc: Local build
|
||||
|
|
|
|||
Loading…
Reference in New Issue