blocks|key|11136|text|我为npm+run+dev想出了办法|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|11137|将my-file.json放在dev-helpers文件夹中。然后它就可以从http://localhost:3200/上的搜索栏中获得。|11138|若要在打开服务器时自动加载dev-helpers/index.html，请更改|11139|url:+"http://petstore.swagger.io/v2/swagger.json"|code-block|syntax|javascript|11140|至|11141|url:+"my-file.json"|11142|entityMap^0|2|B|0|1|C|F|B|12|M|0|D|M|0|0|0|0^^$0|@$1|2|3|4|5|6|7|U|8|@$9|V|A|W|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|X|8|@$9|Y|A|Z|B|C]|$9|10|A|11|B|C]|$9|12|A|13|B|C]]|D|@]|E|$]]|$1|H|3|I|5|6|7|14|8|@$9|15|A|16|B|C]]|D|@]|E|$]]|$1|J|3|K|5|L|7|17|8|@]|D|@]|E|$M|N]]|$1|O|3|P|5|6|7|18|8|@]|D|@]|E|$]]|$1|Q|3|R|5|L|7|19|8|@]|D|@]|E|$M|N]]|$1|S|3|-4|5|6|7|1A|8|@]|D|@]|E|$]]]|T|$]]

I figured it out for <code>npm run dev</code>:

Place <code>my-file.json</code> in the <code>dev-helpers</code> folder. Then it's available from the search bar in on <code>http://localhost:3200/</code>.

To load it automatically when opening the server, alter <code>dev-helpers/index.html</code> by changing

<pre><code>url: "http://petstore.swagger.io/v2/swagger.json"
</code></pre>

to

<pre><code>url: "my-file.json"
</code></pre>

blocks|key|11182|text|为了防止您使用Play+Framework运行maven项目，下面的步骤解决了我的问题：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|11183|1.)更改conf/路由文件。添加以下一行:+GET+/swagger.json+/swagger.json+file="swagger.json")|11184|2.)将swagger.json文件添加到Swagger文件夹中|11185|因此，当您在端口示例7777中运行mvn项目时，使用mvn+2:+run启动play服务器，然后localhost:7777/docs将自动提取本地添加的Json文件。|11186|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|J|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|K|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|L|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|M|8|@]|9|@]|A|$]]|$1|H|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|I|$]]

Just in case you are running a maven project with Play Framework the following steps solved my issue : 

1.) Alter the conf/routes file. Add the below line :
 GET /swagger.json controllers.Assets.at(path="/public/swagger-ui",file="swagger.json")

2.) Add the swagger.json file to your Swagger-UI folder 

so when you run the mvn project in a port example 7777, start the play server using mvn play2:run and then, localhost:7777/docs will automatically pull the Json file that is added locally.

blocks|key|11250|text|确保卷正在挂载正确的本地目录。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|11251|在本地，我在$PWD/src/app/swagger/swagger.yaml中使用了我的swagger配置。运行以下操作很好：|offset|length|style|CODE|11252|docker+run+-p+80:8080+-e+SWAGGER_JSON=/tmp/swagger.yaml+-v+`pwd`/src/app/swagger:/tmp+swaggerapi/swagger-ui|code-block|syntax|javascript|11253|只需刷新Swagger-UI页面或单击标题中的“探索”按钮即可触发YAML文件中数据的刷新。|11254|您还可以指定BASE_URL摘录自自夸-安装。|11255|docker+run+-p+80:8080+-e+BASE_URL=/swagger+-e+SWAGGER_JSON=/foo/swagger.json+-v+/bar:/foo+swaggerapi/swagger-ui|11256|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md^0|0|6|X|0|0|0|6|8|H|5|0|0|0|33|0^^$0|@$1|2|3|4|5|6|7|10|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|11|8|@$D|12|E|13|F|G]]|9|@]|A|$]]|$1|H|3|I|5|J|7|14|8|@]|9|@]|A|$K|L]]|$1|M|3|N|5|6|7|15|8|@]|9|@]|A|$]]|$1|O|3|P|5|6|7|16|8|@$D|17|E|18|F|G]]|9|@$D|19|E|1A|1|1B]]|A|$]]|$1|Q|3|R|5|6|7|1C|8|@$D|1D|E|1E|F|G]]|9|@]|A|$]]|$1|S|3|-4|5|6|7|1F|8|@]|9|@]|A|$]]]|T|$U|$5|V|W|X|A|$Y|Z]]]]

Make sure you are volume mounting the correct local directory.
Locally, I had my swagger config in <code>$PWD/src/app/swagger/swagger.yaml</code>. Running the following worked fine:
<pre><code>docker run -p 80:8080 -e SWAGGER_JSON=/tmp/swagger.yaml -v `pwd`/src/app/swagger:/tmp swaggerapi/swagger-ui
</code></pre>
Simply refreshing the Swagger-UI page or clicking the &quot;Explore&quot; button in the header triggered a refresh of the data from my YAML file.
You can also specify <code>BASE_URL</code> excerpt from <a href="https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md" rel="nofollow noreferrer">swagger-installation</a>
<code>docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui</code>

blocks|key|11299|text|我之所以找到这个主题，是因为我希望看到本地swagger文件的可视化表示，但似乎无法获得swagger(运行在docker中)来显示除petstore以外的任何内容。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|11300|最终，我的问题是理解-e+SWAGGER_JSON和-v标志，所以我想在这里解释它们。|11301|-v+<path1>:<path2>|code-block|syntax|javascript|11302|此选项表示“将路径从我的本地文件系统安装在路径上的swagger-ui停靠容器中”。|11303|-e+SWAGGER_JSON=<filepath>|11304|此选项表示“默认情况下，在使用docker容器的文件系统时显示文件的显示”。这里最重要的是，这个文件应该考虑到您在上面设置的内容。|11305|把所有这些放在一起，我最终得到了以下结果：|11306|docker+run+-p+8085:8080+-e+SWAGGER_JSON=/foo/swagger.json+-v+`pwd`:/foo+swaggerapi/swagger-ui|11307|这里用英语写着：“在端口8085上运行我的swagger-ui实例。将我当前的工作目录安装为'/foo‘在docker容器中。默认情况下，在’/foo/swagger.json‘处显示swagger文件。”|11308|需要注意的是，我的当前工作目录中有一个名为swagger.json的文件。此命令将我当前的工作目录挂载为/foo。然后，swagger可以拿起我的swagger.json作为/foo/swagger.json。|11309|entityMap^0|0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Y|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|Z|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|10|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|11|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|12|8|@]|9|@]|A|$G|H]]|$1|M|3|N|5|6|7|13|8|@]|9|@]|A|$]]|$1|O|3|P|5|6|7|14|8|@]|9|@]|A|$]]|$1|Q|3|R|5|F|7|15|8|@]|9|@]|A|$G|H]]|$1|S|3|T|5|6|7|16|8|@]|9|@]|A|$]]|$1|U|3|V|5|6|7|17|8|@]|9|@]|A|$]]|$1|W|3|-4|5|6|7|18|8|@]|9|@]|A|$]]]|X|$]]

I found this topic because I wanted to see a visual representation of my local swagger file, but could not seem to get swagger-ui (running in docker) to display anything other than the petstore.

Ultimately, my issue was with understanding the -e SWAGGER_JSON and -v flags, so I wanted to explain them here.

<pre><code>-v &lt;path1&gt;:&lt;path2&gt;
</code></pre>

This option says "Mount the path &lt;path1&gt; from my local file system within the swagger-ui docker container on path &lt;path2&gt;"

<pre><code>-e SWAGGER_JSON=&lt;filepath&gt;
</code></pre>

This option says "By default, show the swagger for the file at &lt;filepath&gt; using the docker container's file system." The important part here, is that this filepath should take into account how you set &lt;path2&gt; above

Putting it all together, I ended up with the following:

<pre><code>docker run -p 8085:8080 -e SWAGGER_JSON=/foo/swagger.json -v `pwd`:/foo swaggerapi/swagger-ui
</code></pre>

This says in english: "Run my swagger-ui instance on port 8085. Mount my current working directory as '/foo' in the docker container. By default, show the swagger file at '/foo/swagger.json'."

The important thing to note is that I have a file called swagger.json in my current working directory. This command mounts my current working directory as /foo in the docker container. Then, swagger UI can pick up my swagger.json as /foo/swagger.json.

blocks|key|11336|text|下面是我如何解决这个问题的方法，它还允许您拥有多个YML文件：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|11337|docker+run+-p+80:8080+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++-e+URLS_PRIMARY_NAME=FIRST+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++-e+URLS="[+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++{+url:+'docs/first.yml',+name:+'FIRST'+}+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++,+{+url:+'docs/second.yml',+name:+'SECOND'+}+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++]"+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++-v+`pwd`:/usr/share/nginx/html/docs/+\+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++swaggerapi/swagger-ui+++|code-block|syntax|javascript|11338|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

Here's how I ended up solving this, it also allows you to have multiple YML files:

<pre><code>docker run -p 80:8080 \ 
 -e URLS_PRIMARY_NAME=FIRST \ 
 -e URLS="[ \ 
 { url: 'docs/first.yml', name: 'FIRST' } \ 
 , { url: 'docs/second.yml', name: 'SECOND' } \ 
 ]" \ 
 -v `pwd`:/usr/share/nginx/html/docs/ \ 
 swaggerapi/swagger-ui 
</code></pre>

blocks|key|11997|text|码头工人组成解决方案：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|11998|创建.env文件并添加以下内容：|11999|URLS_PRIMARY_NAME=FIRST
URLS=[+{+url:+'docs/swagger.yaml',+name:+'FIRST'+}+]|code-block|syntax|javascript|12000|并创建一个包含以下内容的坞-撰写文件：|12001|version:+"3.3"

services:
+swagger-ui:
++image:+swaggerapi/swagger-ui
++container_name:+"swagger-ui"
++ports:
++++-+"80:8080"
++volumes:
+++-+/local/tmp:/usr/share/nginx/html/docs/
++environment:
++++-+URLS_PRIMARY_NAME=${URLS_PRIMARY_NAME}
++++-+URLS=${URLS}|12002|swagger.yaml位于/local/tmp。|12003|entityMap^0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|R|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|S|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|T|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|U|8|@]|9|@]|A|$G|H]]|$1|M|3|N|5|6|7|V|8|@]|9|@]|A|$]]|$1|O|3|-4|5|6|7|W|8|@]|9|@]|A|$]]]|P|$]]

Docker compose solution:
create .env file and add the following:
<pre><code>URLS_PRIMARY_NAME=FIRST
URLS=[ { url: 'docs/swagger.yaml', name: 'FIRST' } ]
</code></pre>
And create a docker-compose file with contents below:
<pre><code>version: &quot;3.3&quot;

services:
 swagger-ui:
 image: swaggerapi/swagger-ui
 container_name: &quot;swagger-ui&quot;
 ports:
 - &quot;80:8080&quot;
 volumes:
 - /local/tmp:/usr/share/nginx/html/docs/
 environment:
 - URLS_PRIMARY_NAME=${URLS_PRIMARY_NAME}
 - URLS=${URLS}
</code></pre>
the swagger.yaml is at /local/tmp.

blocks|key|11408|text|对于在mac上面临这一问题的人来说，这是一个权限问题。默认情况下，在Catalina之后，docker不具有允许其图像在系统中读取本地文件的权限。一旦它给了我，它对我起作用，它拿走了我的本地装腔作势的json文件。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|11409|现在要授予特权，请转到>Security&Privacy>+Files和文件夹，并为Mac和您的共享目录添加Docker。|11410|📷|atomic|offset|length|11411|​|11412|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://developer.qcloudimg.com/http-save/yehe-900000/4b4542a71e1a38c369db6d75f170f9ee.png|imageAlt^0|0|0|0|1|0|0|0^^$0|@$1|2|3|4|5|6|7|T|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|U|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|V|8|@]|9|@$G|W|H|X|1|Y]]|A|$]]|$1|I|3|J|5|6|7|Z|8|@]|9|@]|A|$]]|$1|K|3|-4|5|6|7|10|8|@]|9|@]|A|$]]]|L|$M|$5|N|O|P|A|$Q|R|S|-4]]]]

For people facing this issue in mac, its a permission problem. By default after Catalina, docker doesn't have permission to allow its images to read local files in your system. Once its given it worked for me and it took my local swagger json file.
To grant privileges now, go to System preferences &gt; Security &amp; Privacy &gt; Files and Folders, and add Docker for Mac and your shared directory.
<a href="https://i.stack.imgur.com/uU3JV.png" rel="nofollow noreferrer"><img src="https://i.stack.imgur.com/uU3JV.png" alt="enter image description here" /></a>

blocks|key|11457|text|如果希望提供多个URL并从特定文件夹(不是默认的/usr/share/nginx/html/docs/)提供另一种解决方案：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|11458|docker+run+-p+80:8080+\
++++-e+SWAGGER_JSON=/docs/api.yaml+\
++++-e+URLS="[+\
++++++++{+url:+'/api1.yaml',+name:+'API+1'+},+\
++++++++{+url:+'/api2.yaml',+name:+'API+2'+}+\
++++]"+\
++++-v+`pwd`/docs:/docs+\
++++swaggerapi/swagger-ui|code-block|syntax|javascript|11459|或者是码头工：|11460|version:+'3.8'
services:
++swagger-ui:
++++image:+swaggerapi/swagger-ui
++++volumes:
++++++-+./docs:/docs
++++environment:
++++++SWAGGER_JSON:+/docs/api.yaml
++++++URLS:+'[{+url:+"/api1.yaml",+name:+"API+1"+},+{+url:+"/api2.yaml",+name:+"API+2"+}]'|11461|请注意，SWAGGER_JSON需要一个绝对路径，URLS中的URL需要指定卷的相对路径。|11462|entityMap^0|O|R|0|0|0|0|4|C|P|4|0^^$0|@$1|2|3|4|5|6|7|S|8|@$9|T|A|U|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|V|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|W|8|@]|D|@]|E|$]]|$1|M|3|N|5|H|7|X|8|@]|D|@]|E|$I|J]]|$1|O|3|P|5|6|7|Y|8|@$9|Z|A|10|B|C]|$9|11|A|12|B|C]]|D|@]|E|$]]|$1|Q|3|-4|5|6|7|13|8|@]|D|@]|E|$]]]|R|$]]

Another solution if you want to provide multiple URLs and from a specific folder (not default <code>/usr/share/nginx/html/docs/</code>):
<pre><code>docker run -p 80:8080 \
 -e SWAGGER_JSON=/docs/api.yaml \
 -e URLS=&quot;[ \
 { url: '/api1.yaml', name: 'API 1' }, \
 { url: '/api2.yaml', name: 'API 2' } \
 ]&quot; \
 -v `pwd`/docs:/docs \
 swaggerapi/swagger-ui
</code></pre>
Or for docker compose:
<pre><code>version: '3.8'
services:
 swagger-ui:
 image: swaggerapi/swagger-ui
 volumes:
 - ./docs:/docs
 environment:
 SWAGGER_JSON: /docs/api.yaml
 URLS: '[{ url: &quot;/api1.yaml&quot;, name: &quot;API 1&quot; }, { url: &quot;/api2.yaml&quot;, name: &quot;API 2&quot; }]'
</code></pre>
Please note, <code>SWAGGER_JSON</code> requires an absolute path, URLs in <code>URLS</code> require relative paths from the specified volume

The Readme on <a href="https://github.com/swagger-api/swagger-ui" rel="noreferrer">https://github.com/swagger-api/swagger-ui</a> specifies that Swagger-UI can be run with your own file like this

<pre><code>docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui
</code></pre>

which works I if I translate it to

<pre><code>docker build . -t swagger-ui-local &amp;&amp; \
 docker run -p 80:8080 -e SWAGGER_JSON=/foo/my-file.json -v $PWD:/foo swagger-ui-local
</code></pre>

This, however, ignores my local changes.

I can run my local changes with

<pre><code>npm run dev
</code></pre>

but I can't figure out how to get this dev server to run anything else than the Petstore example.

Can anyone help me combine the two, so I can run swagger-ui with local code changes AND my own swagger.json?

How to run swagger-ui with local code changes AND my own swagger.json?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

上的自述文件指定Swagger-UI可以使用您自己的文件运行，如下所示docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui如果我把它翻译成docker build . -t swagger-u...

问如何使用本地代码更改和我自己的swagger.json运行swagger？
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何使用本地代码更改和我自己的swagger.json运行swagger？EN