thegeneralist01/twitter-openapi
1
Fork 0
mirror of https://github.com/thegeneralist01/twitter-openapi synced 2026-01-11 15:40:26 +01:00
Code Issues Activity

update README

Browse source 
Signed-off-by: ふぁ <yuki@yuki0311.com>
This commit is contained in:
ふぁ 2023-05-02 22:01:27 +09:00
parent ac6aa86138
commit d9ab053b00
No known key found for this signature in database
GPG key ID: 83A8A5E74872A8AA
1 changed files with 1 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -24,54 +24,7 @@ Note that the license also inherits to the output.
- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json)
- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file.
### About build
- `src/openapi/**/*.yaml#/paths/*/*/parameters` will be overwritten by `src/config/parameters.yaml#/paths/~1parameters/*/parameters`
- This overwritten done before parsing yaml
- `src/openapi/**/*.yaml#/paths/*/*/requestBody` will be overwritten by `src/config/parameters.yaml#/paths/~1parameters/*/requestBody`
- This overwritten done before parsing yaml
- `src/openapi/**/*.yaml#/paths/*/get/responses/200/headers` will be overwritten by `src/config/headers.yaml#/components/headers`
- This overwritten done before parsing yaml
- Items enclosed in double brackets are placeholders
- `src/config/placeholder.json` replaces it
- If a placeholder is used in `src/config/**/*.yaml`, the pathname is added as a prefix
- This substitution is done before parsing the yaml
#### variable.json
It can be written as `{% if variable == value %}` `{ endif }`
| lang | description|
|---|---|
| docs | Outputs the most correct swagger syntax |
| typescript | Since it is difficult to handle default values with the typescript generator, we refer to `src/config/placeholder.json` and handle default values |
| dart | Basically the same as typescript, but headers are processed as parameters |
##### *_parameters = string
- This is defined in `src/config/parameters.yaml`
- Replace `src/config/placeholder.json` as an string
##### *_parameters = object
- This is defined in `src/config/parameters.yaml`
- Replace `src/config/placeholder.json` as an object
##### *_parameters = schema_content
- The schema automatically generated from the `src/config/placeholder.json` is replaced with `src/openapi/**/*.yaml#/paths/*/*/parameters`
- Some generators cannot handle it correctly because it generates the syntax introduced in swagger 3.0
- This is defined in `tools/build.py`
##### *_parameters = schema_parameters
- The schema automatically generated from the `src/config/placeholder.json` is replaced with `src/openapi/**/*.yaml#/paths/*/*/parameters`
##### *_parameters = schema_request_body
- The schema automatically generated from the `src/config/placeholder.json` is replaced with `src/openapi/**/*.yaml#/paths/*/*/requestBody`
#### command
### build
```shell
python -V # Python 3.10.8