From 9292396d971f33f3f47c533e71d24236af5db5da Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 27 Jul 2022 10:48:31 +0800 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9991f96..f0cf59b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # openapi-scripts Scripts used in postprocessing OpenAPI document for ReDoc. + ## Postprocess the JSON file generated by `bufbuild/buf` ### dereference + Use [@apidevtools/json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser) to dereference the auto-generated JSON file. + ### Generate code sample -ToDo + +Use [openapi-snippet](https://github.com/ErikWittern/openapi-snippet) to generate code samples automatically. + ### Convert string to int for int32 type in `.proto` + ToDo ### Import markown files Embed external Markdown file contents to the `info.description` auto-generated JSON file. See [Redoc documentation](https://redocly.com/docs/api-reference-docs/guides/embedded-markdown/) for more information. -### Add x-logo +### Add `x-logo` [`x-logo`](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-logo) is a [vendor extension](https://swagger.io/specification/#specificationExtensions) from Redoc. It allows you to show a custom logo on the left upper corner of your redoc output.