Skip to content

Commit

Permalink
fix: server quickstart swagger-ui image link (#325)
Browse files Browse the repository at this point in the history
* fix server Swagger UI img link

* fix server Swagger UI img link f4b6519
  • Loading branch information
imbajin committed Jan 22, 2024
1 parent 6fa7ba1 commit b1038db
Show file tree
Hide file tree
Showing 19 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion cn/docs/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@
</span></span><span style=display:flex><span> <span style=color:#a40000>...</span>
</span></span><span style=display:flex><span> <span style=color:#000;font-weight:700>]</span>
</span></span><span style=display:flex><span><span style=color:#000;font-weight:700>}</span>
</span></span></code></pre></div><p id=swaggerui-example></p><p>详细的 API 请参考 <a href=/docs/clients/restful-api>RESTful-API</a> 文档。</p><p>另外也可以通过访问 <code>localhost:8080/swagger-ui/index.html</code> 查看 API。</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui示例.png alt=image></div><p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时,如果 HugeGraph Server 开启了鉴权模式,可以在 Swagger 页面输入鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui-where-set-auth-example.png alt=image></div><p>当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui-set-auth-example.png alt=image></div><h3 id=7-停止-server>7 停止 Server</h3><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#000>$cd</span> *hugegraph-<span style=color:#4e9a06>${</span><span style=color:#000>version</span><span style=color:#4e9a06>}</span>
</span></span></code></pre></div><p id=swaggerui-example></p><p>详细的 API 请参考 <a href=/docs/clients/restful-api>RESTful-API</a> 文档。</p><p>另外也可以通过访问 <code>localhost:8080/swagger-ui/index.html</code> 查看 API。</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui.png alt=image></div><p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时,如果 HugeGraph Server 开启了鉴权模式,可以在 Swagger 页面输入鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui-where-set-auth-example.png alt=image></div><p>当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui-set-auth-example.png alt=image></div><h3 id=7-停止-server>7 停止 Server</h3><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#000>$cd</span> *hugegraph-<span style=color:#4e9a06>${</span><span style=color:#000>version</span><span style=color:#4e9a06>}</span>
</span></span><span style=display:flex><span><span style=color:#000>$bin</span>/stop-hugegraph.sh
</span></span></code></pre></div><h3 id=8-使用-intellij-idea-调试-server>8 使用 IntelliJ IDEA 调试 Server</h3><p>请参考<a href=/docs/contribution-guidelines/hugegraph-server-idea-setup>在 IDEA 中配置 Server 开发环境</a></p></div><div class=td-content style=page-break-before:always><h1 id=pg-685a02f8811d86f1ce195d7c73d9ea44>3.2 - HugeGraph-Loader Quick Start</h1><h3 id=1-hugegraph-loader-概述>1 HugeGraph-Loader 概述</h3><p>HugeGraph-Loader 是 HugeGraph 的数据导入组件,能够将多种数据源的数据转化为图的顶点和边并批量导入到图数据库中。</p><p>目前支持的数据源包括:</p><ul><li>本地磁盘文件或目录,支持 TEXT、CSV 和 JSON 格式的文件,支持压缩文件</li><li>HDFS 文件或目录,支持压缩文件</li><li>主流关系型数据库,如 MySQL、PostgreSQL、Oracle、SQL Server</li></ul><p>本地磁盘文件和 HDFS 文件支持断点续传。</p><p>后面会具体说明。</p><blockquote><p>注意:使用 HugeGraph-Loader 需要依赖 HugeGraph Server 服务,下载和启动 Server 请参考 <a href=/docs/quickstart/hugegraph-server>HugeGraph-Server Quick Start</a></p></blockquote><h3 id=2-获取-hugegraph-loader>2 获取 HugeGraph-Loader</h3><p>有两种方式可以获取 HugeGraph-Loader:</p><ul><li>下载已编译的压缩包</li><li>克隆源码编译安装</li><li>使用 Docker 镜像 (便于<strong>测试</strong>)</li></ul><h4 id=21-下载已编译的压缩包>2.1 下载已编译的压缩包</h4><p>下载最新版本的 HugeGraph-Toolchain Release 包,里面包含了 loader + tool + hubble 全套工具,如果你已经下载,可跳过重复步骤</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span>wget https://downloads.apache.org/incubator/hugegraph/<span style=color:#ce5c00;font-weight:700>{</span>version<span style=color:#ce5c00;font-weight:700>}</span>//apache-hugegraph-toolchain-incubating-<span style=color:#ce5c00;font-weight:700>{</span>version<span style=color:#ce5c00;font-weight:700>}</span>.tar.gz
</span></span><span style=display:flex><span>tar zxf *hugegraph*.tar.gz
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added cn/docs/images/images-server/swagger-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions cn/docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1766,15 +1766,15 @@
&lt;p>详细的 API 请参考 &lt;a href="/docs/clients/restful-api">RESTful-API&lt;/a> 文档。&lt;/p>
&lt;p>另外也可以通过访问 &lt;code>localhost:8080/swagger-ui/index.html&lt;/code> 查看 API。&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui示例.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui.png" alt="image">
&lt;/div>
&lt;p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时,如果 HugeGraph Server 开启了鉴权模式,可以在 Swagger 页面输入鉴权信息。&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui-where-set-auth-example.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui-where-set-auth-example.png" alt="image">
&lt;/div>
&lt;p>当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui-set-auth-example.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui-set-auth-example.png" alt="image">
&lt;/div>
&lt;h3 id="7-停止-server">7 停止 Server&lt;/h3>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#000">$cd&lt;/span> *hugegraph-&lt;span style="color:#4e9a06">${&lt;/span>&lt;span style="color:#000">version&lt;/span>&lt;span style="color:#4e9a06">}&lt;/span>
Expand Down
2 changes: 1 addition & 1 deletion cn/docs/quickstart/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@
</span></span><span style=display:flex><span> <span style=color:#a40000>...</span>
</span></span><span style=display:flex><span> <span style=color:#000;font-weight:700>]</span>
</span></span><span style=display:flex><span><span style=color:#000;font-weight:700>}</span>
</span></span></code></pre></div><p id=swaggerui-example></p><p>详细的 API 请参考 <a href=/docs/clients/restful-api>RESTful-API</a> 文档。</p><p>另外也可以通过访问 <code>localhost:8080/swagger-ui/index.html</code> 查看 API。</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui示例.png alt=image></div><p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时,如果 HugeGraph Server 开启了鉴权模式,可以在 Swagger 页面输入鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui-where-set-auth-example.png alt=image></div><p>当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui-set-auth-example.png alt=image></div><h3 id=7-停止-server>7 停止 Server</h3><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#000>$cd</span> *hugegraph-<span style=color:#4e9a06>${</span><span style=color:#000>version</span><span style=color:#4e9a06>}</span>
</span></span></code></pre></div><p id=swaggerui-example></p><p>详细的 API 请参考 <a href=/docs/clients/restful-api>RESTful-API</a> 文档。</p><p>另外也可以通过访问 <code>localhost:8080/swagger-ui/index.html</code> 查看 API。</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui.png alt=image></div><p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时,如果 HugeGraph Server 开启了鉴权模式,可以在 Swagger 页面输入鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui-where-set-auth-example.png alt=image></div><p>当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui-set-auth-example.png alt=image></div><h3 id=7-停止-server>7 停止 Server</h3><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#000>$cd</span> *hugegraph-<span style=color:#4e9a06>${</span><span style=color:#000>version</span><span style=color:#4e9a06>}</span>
</span></span><span style=display:flex><span><span style=color:#000>$bin</span>/stop-hugegraph.sh
</span></span></code></pre></div><h3 id=8-使用-intellij-idea-调试-server>8 使用 IntelliJ IDEA 调试 Server</h3><p>请参考<a href=/docs/contribution-guidelines/hugegraph-server-idea-setup>在 IDEA 中配置 Server 开发环境</a></p></div><div class=td-content style=page-break-before:always><h1 id=pg-685a02f8811d86f1ce195d7c73d9ea44>2 - HugeGraph-Loader Quick Start</h1><h3 id=1-hugegraph-loader-概述>1 HugeGraph-Loader 概述</h3><p>HugeGraph-Loader 是 HugeGraph 的数据导入组件,能够将多种数据源的数据转化为图的顶点和边并批量导入到图数据库中。</p><p>目前支持的数据源包括:</p><ul><li>本地磁盘文件或目录,支持 TEXT、CSV 和 JSON 格式的文件,支持压缩文件</li><li>HDFS 文件或目录,支持压缩文件</li><li>主流关系型数据库,如 MySQL、PostgreSQL、Oracle、SQL Server</li></ul><p>本地磁盘文件和 HDFS 文件支持断点续传。</p><p>后面会具体说明。</p><blockquote><p>注意:使用 HugeGraph-Loader 需要依赖 HugeGraph Server 服务,下载和启动 Server 请参考 <a href=/docs/quickstart/hugegraph-server>HugeGraph-Server Quick Start</a></p></blockquote><h3 id=2-获取-hugegraph-loader>2 获取 HugeGraph-Loader</h3><p>有两种方式可以获取 HugeGraph-Loader:</p><ul><li>下载已编译的压缩包</li><li>克隆源码编译安装</li><li>使用 Docker 镜像 (便于<strong>测试</strong>)</li></ul><h4 id=21-下载已编译的压缩包>2.1 下载已编译的压缩包</h4><p>下载最新版本的 HugeGraph-Toolchain Release 包,里面包含了 loader + tool + hubble 全套工具,如果你已经下载,可跳过重复步骤</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span>wget https://downloads.apache.org/incubator/hugegraph/<span style=color:#ce5c00;font-weight:700>{</span>version<span style=color:#ce5c00;font-weight:700>}</span>//apache-hugegraph-toolchain-incubating-<span style=color:#ce5c00;font-weight:700>{</span>version<span style=color:#ce5c00;font-weight:700>}</span>.tar.gz
</span></span><span style=display:flex><span>tar zxf *hugegraph*.tar.gz
Expand Down
8 changes: 4 additions & 4 deletions cn/docs/quickstart/hugegraph-server/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions cn/docs/quickstart/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -452,15 +452,15 @@
&lt;p>详细的 API 请参考 &lt;a href="/docs/clients/restful-api">RESTful-API&lt;/a> 文档。&lt;/p>
&lt;p>另外也可以通过访问 &lt;code>localhost:8080/swagger-ui/index.html&lt;/code> 查看 API。&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui示例.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui.png" alt="image">
&lt;/div>
&lt;p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时,如果 HugeGraph Server 开启了鉴权模式,可以在 Swagger 页面输入鉴权信息。&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui-where-set-auth-example.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui-where-set-auth-example.png" alt="image">
&lt;/div>
&lt;p>当前 HugeGraph 支持基于 Basic 和 Bearer 两种形式设置鉴权信息。&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui-set-auth-example.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui-set-auth-example.png" alt="image">
&lt;/div>
&lt;h3 id="7-停止-server">7 停止 Server&lt;/h3>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#000">$cd&lt;/span> *hugegraph-&lt;span style="color:#4e9a06">${&lt;/span>&lt;span style="color:#000">version&lt;/span>&lt;span style="color:#4e9a06">}&lt;/span>
Expand Down
2 changes: 1 addition & 1 deletion cn/sitemap.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@
</span></span><span style=display:flex><span> ...
</span></span><span style=display:flex><span> ]
</span></span><span style=display:flex><span>}
</span></span></code></pre></div><p id=swaggerui-example></p><p>For detailed API, please refer to <a href=/docs/clients/restful-api>RESTful-API</a></p><p>You can also visit <code>localhost:8080/swagger-ui/index.html</code> to check the API.</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui示例.png alt=image></div><p>When using Swagger UI to debug the API provided by HugeGraph, if HugeGraph Server turns on authentication mode, you can enter authentication information on the Swagger page.</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui-where-set-auth-example.png alt=image></div><p>Currently HugeGraph supports setting authentication information in two forms: Basic and Bearer.</p><div style=text-align:center><img src=/docs/images/images-server/621swaggerui-set-auth-example.png alt=image></div><h3 id=7-stop-server>7 Stop Server</h3><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#000>$cd</span> *hugegraph-<span style=color:#4e9a06>${</span><span style=color:#000>version</span><span style=color:#4e9a06>}</span>
</span></span></code></pre></div><p id=swaggerui-example></p><p>For detailed API, please refer to <a href=/docs/clients/restful-api>RESTful-API</a></p><p>You can also visit <code>localhost:8080/swagger-ui/index.html</code> to check the API.</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui.png alt=image></div><p>When using Swagger UI to debug the API provided by HugeGraph, if HugeGraph Server turns on authentication mode, you can enter authentication information on the Swagger page.</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui-where-set-auth-example.png alt=image></div><p>Currently, HugeGraph supports setting authentication information in two forms: Basic and Bearer.</p><div style=text-align:center><img src=/docs/images/images-server/swagger-ui-set-auth-example.png alt=image></div><h3 id=7-stop-server>7 Stop Server</h3><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span><span style=color:#000>$cd</span> *hugegraph-<span style=color:#4e9a06>${</span><span style=color:#000>version</span><span style=color:#4e9a06>}</span>
</span></span><span style=display:flex><span><span style=color:#000>$bin</span>/stop-hugegraph.sh
</span></span></code></pre></div><h3 id=8-debug-server-with-intellij-idea>8 Debug Server with IntelliJ IDEA</h3><p>Please refer to <a href=/docs/contribution-guidelines/hugegraph-server-idea-setup>Setup Server in IDEA</a></p></div><div class=td-content style=page-break-before:always><h1 id=pg-685a02f8811d86f1ce195d7c73d9ea44>3.2 - HugeGraph-Loader Quick Start</h1><h3 id=1-hugegraph-loader-overview>1 HugeGraph-Loader Overview</h3><p>HugeGraph-Loader is the data import component of HugeGraph, which can convert data from various data sources into graph vertices and edges and import them into the graph database in batches.</p><p>Currently supported data sources include:</p><ul><li>Local disk file or directory, supports TEXT, CSV and JSON format files, supports compressed files</li><li>HDFS file or directory, supports compressed files</li><li>Mainstream relational databases, such as MySQL, PostgreSQL, Oracle, SQL Server</li></ul><p>Local disk files and HDFS files support resumable uploads.</p><p>It will be explained in detail below.</p><blockquote><p>Note: HugeGraph-Loader requires HugeGraph Server service, please refer to <a href=/docs/quickstart/hugegraph-server>HugeGraph-Server Quick Start</a> to download and start Server</p></blockquote><h3 id=2-get-hugegraph-loader>2 Get HugeGraph-Loader</h3><p>There are two ways to get HugeGraph-Loader:</p><ul><li>Download the compiled tarball</li><li>Clone source code then compile and install</li><li>Use docker image (Convenient for Test/Dev)</li></ul><h4 id=21-download-the-compiled-archive>2.1 Download the compiled archive</h4><p>Download the latest version of the HugeGraph-Toolchain release package:</p><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-bash data-lang=bash><span style=display:flex><span>wget https://downloads.apache.org/incubator/hugegraph/<span style=color:#ce5c00;font-weight:700>{</span>version<span style=color:#ce5c00;font-weight:700>}</span>/apache-hugegraph-toolchain-incubating-<span style=color:#ce5c00;font-weight:700>{</span>version<span style=color:#ce5c00;font-weight:700>}</span>.tar.gz
</span></span><span style=display:flex><span>tar zxf *hugegraph*.tar.gz
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/images-server/swagger-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1887,15 +1887,15 @@ after the service is stopped artificially, or when the service needs to be start
&lt;p>For detailed API, please refer to &lt;a href="/docs/clients/restful-api">RESTful-API&lt;/a>&lt;/p>
&lt;p>You can also visit &lt;code>localhost:8080/swagger-ui/index.html&lt;/code> to check the API.&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui示例.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui.png" alt="image">
&lt;/div>
&lt;p>When using Swagger UI to debug the API provided by HugeGraph, if HugeGraph Server turns on authentication mode, you can enter authentication information on the Swagger page.&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui-where-set-auth-example.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui-where-set-auth-example.png" alt="image">
&lt;/div>
&lt;p>Currently HugeGraph supports setting authentication information in two forms: Basic and Bearer.&lt;/p>
&lt;p>Currently, HugeGraph supports setting authentication information in two forms: Basic and Bearer.&lt;/p>
&lt;div style="text-align: center;">
&lt;img src="/docs/images/images-server/621swaggerui-set-auth-example.png" alt="image">
&lt;img src="/docs/images/images-server/swagger-ui-set-auth-example.png" alt="image">
&lt;/div>
&lt;h3 id="7-stop-server">7 Stop Server&lt;/h3>
&lt;div class="highlight">&lt;pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-bash" data-lang="bash">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#000">$cd&lt;/span> *hugegraph-&lt;span style="color:#4e9a06">${&lt;/span>&lt;span style="color:#000">version&lt;/span>&lt;span style="color:#4e9a06">}&lt;/span>
Expand Down
Loading

0 comments on commit b1038db

Please sign in to comment.