对于那些在PHP中撰写的一些REST AP,我被要求创建文件,因为我不知道有哪一种简单的方式来通知这些现有APIC并制作这种文件,我使用了,以产生一些文件。
I saved the JSON and YAML files created using that editor, and now I need to create the "interactive" Swagger documentation from there.
请允许我知道,我如何能够将Swagger JSON的规格文件转换为实际的Swagger文件?
我在Windows平台上,不了解有关Ant/Maven的任何情况。
Update May 17, 2023
Seems redoc-cli has been deprecated. so use https://www.npmjs.com/package/@redocly/cli instead. [Credit : @Dave]
引自。
然后,我发现 使用和产出非常容易,其真实性是2个湿度、single和美丽指数.html文档。
<<>Installation
npm install -g redoc-cli
<>Usage:
redoc-cli bundle -o index.html swagger.json
Everything was too difficult or badly documented so I solved this with a simple script swagger-yaml-to-html.py, which works like this
python swagger-yaml-to-html.py < /path/to/api.yaml > doc.html
这对马来那是这样,但为了与马森公司合作而加以修改也是微不足道的。
I spent a lot of time and tried a lot of different solutions - in the end I did it this way :
<html>
<head>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui.css">
<script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"></script>
<script>
function render() {
var ui = SwaggerUIBundle({
url: `path/to/my/swagger.yaml`,
dom_id: #swagger-ui ,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIBundle.SwaggerUIStandalonePreset
]
});
}
</script>
</head>
<body onload="render()">
<div id="swagger-ui"></div>
</body>
</html>
You just need to have path/to/my/swagger.yaml served from the same location.
(or use CORS headers)
它
I was looking at Swagger Editor and thought it could export the preview pane but turned out it cannot. So I wrote my own version of it.
全面披露: 我是该工具的作者。
See the swagger-api/swagger-codegen project on GitHub ; the project README shows how to use it to generate static HTML. See Generating static html api documentation.
如果你想看到这种夸张。 json You can install the Swagger UI. 你刚刚在网络服务器上部署这个系统(在你打上Gite Hub的邮袋后,左侧夹),并在你的浏览器中看到Swagger UI。 它是 Java本。
EDIT: 2024-04-22
You can now use docker compose like this with openapi.json next to your compose file and containing the spec:
version: 3
services:
swagger-ui:
image: swaggerapi/swagger-ui
container_name: swagger-ui
ports:
- "8080:8080"
environment:
SWAGGER_JSON: /openapi/openapi.json
volumes:
- ./openapi.json:/openapi/openapi.json
<>斯特凡>
You can also download swagger ui from: https://github.com/swagger-api/swagger-ui, take the dist folder, modify index.html: change the constructor
const ui = SwaggerUIBundle({
url: ...,
页: 1
const ui = SwaggerUIBundle({
spec: YOUR_JSON,
如今,左侧有你们所需要的一切,可以按需要加以分配。
Swagger AP 3.0, 网上Swagger编辑制作Html2客户代码,对我很有价值!
Redocly s CLI界面有一个工具从开放式消费物价指数光谱文档中建立超文本。
sudo npm i -g @redocly/cli
redocly build-docs my-swagger.yml -o docs.html
查阅这一链接:。
如果需要另一帮助,请表示可以自由要求。
如果你在Gitelab提出“JSON”案,将提交你。
There s a small Java program which generates docs (adoc or md) from a yaml file.
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.ASCIIDOC)
.withSwaggerMarkupLanguage(MarkupLanguage.ASCIIDOC)
.withOutputLanguage(Language.DE)
.build();
Swagger2MarkupConverter builder = Swagger2MarkupConverter.from(yamlFileAsString).withConfig(config).build();
return builder.toFileWithoutExtension(outFile);
遗憾的是,它只支持OpenAPI 2.0,但不支持。
I m 非常满意:https://rapidocweb.com/
为什么我这样说:
I ve been using the YAML format with reasonable success in the last 6 months or so. However, the pure Perl implementation of the YAML parser is fairly fidgety to hand-write a readable file for and ...
as an example, i have a default english locale file "en.yml" with contents: en: messages: messages users: users now, there is a customer which wants messages to be named discussions in his ...
Is it possible to force Ruby to call an initialize method when using YAML.load_file? I want to call the method in order to provide values for instance variables I do not serialize. I know I can ...
I was wondering if anyone knew how to generate a fixture.yml from data that is already existing in the database? As you can use the build-schema to generate a schema, is there a way to do that for ...
I would like to store HTML snippets inside a YAML file. What is the best way to do that? Something like: myhtml: | <div> <a href="#">whatever</a> </div>
How can I parse a YAML file in Python?
I have the following YAML schema for organising users in Doctrine: Person: tableName: people columns: id: type: integer primary: true autoincrement: true firstname: ...
What are the differences between YAML and JSON, specifically considering the following things? Performance (encode/decode time) Memory consumption Expression clarity Library availability, ease of use ...