Skip to content

Commit

Permalink
doc: optimize description about preload, init-store and others (#293)
Browse files Browse the repository at this point in the history 
Co-authored-by: imbajin <[email protected]>

* doc: add swagger link in api doc

---------

Co-authored-by: imbajin <[email protected]> 6210154
  • Loading branch information
@imbajin
imbajin committed Nov 1, 2023
1 parent 89768e8 commit ddc7acb
Show file tree
Hide file tree
Showing 32 changed files with 273 additions and 206 deletions.
12 changes: 3 additions & 9 deletions client-go/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
<html>
<head>
<!--meta name="go-import" content="hugegraph.apache.org/client-go git https://github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go@test-go"-->
<!--meta name="go-import" content="hugegraph.apache.org/client-go git https://github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go"-->
<!--meta name="go-import" content="hugegraph.apache.org/client-go git https://github.com/apache/incubator-hugegraph-toolchain/tree/test-go/hugegraph-client-go"-->
<meta name="go-import" content="hugegraph.apache.org/client-go git https://github.com/apache/hugegraph-toolchain">
<meta name="go-source" content="hugegraph.apache.org/client-go git https://github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go/tree/test-go{/dir} https://github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go/blob/test-go{/dir}/{file}#L{line}">
<!--meta http-equiv="refresh" content="0; url=https://pkg.go.dev/hugegraph.apache.org/client-go"-->
<meta name="go-import" content="hugegraph.apache.org/client-go git https://github.com/incubator-hugegraph-toolchain/hugegraph-client-go.git branch=tmp-go">
<meta name="go-source" content="hugegraph.apache.org/client-go git https://github.com/incubator-hugegraph-toolchain/hugegraph-client-go/tree/tmp-go{/dir} https://github.com/incubator-hugegraph-toolchain/hugegraph-client-go/blob/tmp-go{/dir}/{file}#L{line}">
<meta http-equiv="refresh" content="0; url=https://pkg.go.dev/hugegraph.apache.org/client-go">
</head>

<!--
<body>
<p>Redirecting to <a href="https://pkg.go.dev/hugegraph.apache.org/client-go">pkg.go.dev/hugegraph.apache.org/client-go</a>...</p>
</body>
-->
</html>
37 changes: 20 additions & 17 deletions cn/docs/_print/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion cn/docs/clients/_print/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!doctype html><html lang=cn class=no-js><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=generator content="Hugo 0.102.3"><link rel=canonical type=text/html href=/cn/docs/clients/><link rel=alternate type=application/rss+xml href=/cn/docs/clients/index.xml><meta name=robots content="noindex, nofollow"><link rel="shortcut icon" href=/favicons/favicon.ico><link rel=apple-touch-icon href=/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/favicons/android-96x96.png sizes=96x96><link rel=icon type=image/png href=/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/favicons/android-192x192.png sizes=192x192><title>API | HugeGraph</title><meta name=description content><meta property="og:title" content="API"><meta property="og:description" content="Apache HugeGraph 官网"><meta property="og:type" content="website"><meta property="og:url" content="/cn/docs/clients/"><meta property="og:site_name" content="HugeGraph"><meta itemprop=name content="API"><meta itemprop=description content="Apache HugeGraph 官网"><meta name=twitter:card content="summary"><meta name=twitter:title content="API"><meta name=twitter:description content="Apache HugeGraph 官网"><link rel=preload href=/scss/main.min.1764bdd1b00b15c82ea08e6a847f47114a8787b9770c047a8c6082457466ce2b.css as=style><link href=/scss/main.min.1764bdd1b00b15c82ea08e6a847f47114a8787b9770c047a8c6082457466ce2b.css rel=stylesheet integrity><script src=https://code.jquery.com/jquery-3.5.1.min.js integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin=anonymous></script>
<link rel=stylesheet href=/css/prism.css><script type=application/javascript>var doNotTrack=!1;doNotTrack||(window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-00000000-0","auto"),ga("send","pageview"))</script><script async src=https://www.google-analytics.com/analytics.js></script></head><body class=td-section><header><nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar"><a class=navbar-brand href=/cn/><span class=navbar-logo><svg id="图层_1" data-name="图层 1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 16 16"><defs><style>.cls-1{fill:none;stroke:#fff;stroke-miterlimit:10;stroke-width:.5px;opacity:.3}.cls-2{fill:#229efa}.cls-3{fill:#9948f7}.cls-4{fill:#33bc7a}.cls-5{fill:url(#未命名的渐变_3)}.cls-6{fill:url(#未命名的渐变_13)}.cls-7{fill:url(#未命名的渐变_11)}</style><linearGradient id="未命名的渐变_3" x1="6.16" y1="14.63" x2="6.16" y2="6.01" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#2e3192"/><stop offset="0" stop-color="#229efa"/><stop offset=".44" stop-color="#239cf8"/><stop offset=".6" stop-color="#2795f2"/><stop offset=".71" stop-color="#2d8ae8"/><stop offset=".81" stop-color="#3679d9"/><stop offset=".89" stop-color="#4263c6"/><stop offset=".95" stop-color="#5048af"/><stop offset="1" stop-color="#5c319b"/></linearGradient><linearGradient id="未命名的渐变_13" x1="10.75" y1="8.2" x2="4.49" y2="1.94" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#991146"/><stop offset="0" stop-color="#326b4e"/><stop offset=".02" stop-color="#3a685c"/><stop offset=".07" stop-color="#506180"/><stop offset=".13" stop-color="#645aa0"/><stop offset=".19" stop-color="#7554bc"/><stop offset=".26" stop-color="#8250d2"/><stop offset=".35" stop-color="#8d4ce3"/><stop offset=".45" stop-color="#944aee"/><stop offset=".6" stop-color="#9848f5"/><stop offset="1" stop-color="#9948f7"/></linearGradient><linearGradient id="未命名的渐变_11" x1="15.34" y1="6.67" x2="7.88" y2="10.98" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#33bc7a"/><stop offset=".45" stop-color="#32ba7a"/><stop offset=".61" stop-color="#2fb37c"/><stop offset=".73" stop-color="#29a87e"/><stop offset=".82" stop-color="#219782"/><stop offset=".9" stop-color="#168186"/><stop offset=".97" stop-color="#09668b"/><stop offset="1" stop-color="#03598e"/></linearGradient></defs><title>logo</title><rect class="cls-1" x="-143.14" y="-373.46" width="597.8" height="424.44"/><circle class="cls-2" cx="12.02" cy="1.83" r="1.33"/><circle class="cls-3" cx="12.02" cy="14.17" r="1.33"/><circle class="cls-4" cx="1.33" cy="8" r="1.33"/><path class="cls-5" d="M7.91 10h0a2.65 2.65.0 01-.23-3.74A1.75 1.75.0 017.91 6h0A2.66 2.66.0 014.4 6h0a1.81 1.81.0 01.24.24A2.65 2.65.0 014.4 10h0a2.62 2.62.0 00-.89 2 2.65 2.65.0 104.4-2z"/><path class="cls-6" d="M12.19 5.49a2.78 2.78.0 01-.5.11A2.64 2.64.0 018.76 3.5h0a2.65 2.65.0 10-2.6 3.17A2.6 2.6.0 007 6.53H7a2.65 2.65.0 013.44 2 2.94 2.94.0 010-.51 2.65 2.65.0 011.75-2.53z"/><path class="cls-7" d="M13 5.35a2.64 2.64.0 00-2.59 2.12h0a3 3 0 01-.08.32A2.65 2.65.0 017.54 9.58a2.86 2.86.0 00.37.41h0a2.63 2.63.0 01.9 2 2.84 2.84.0 01-.05.51 2.64 2.64.0 013.12-2.06l.32.08h0a2.6 2.6.0 00.84.14 2.65 2.65.0 100-5.3z"/></svg></span><span class=font-weight-bold>HugeGraph</span></a><div class="td-navbar-nav-scroll ml-md-auto" id=main_navbar><ul class="navbar-nav mt-2 mt-lg-0"><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/cn/docs/><i class='fas fa-book pr-2'></i><span>Documentation</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=https://github.com/apache/incubator-hugegraph target=_blank><i class='fab fa-github pr-2'></i><span>GitHub</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/cn/docs/download/download/><i class='fas fa-download pr-2'></i><span>Download</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/cn/community/><span>Community</span></a></li><li class="nav-item dropdown mr-4 d-none d-lg-block"><a class="nav-link dropdown-toggle" href=# id=navbarDropdown role=button data-toggle=dropdown aria-haspopup=true aria-expanded=false>中文</a><div class=dropdown-menu aria-labelledby=navbarDropdownMenuLink><a class=dropdown-item href=/docs/clients/>English</a></div></li></ul></div><div class="navbar-nav d-none d-lg-block"></div></nav></header><div class="container-fluid td-outer"><div class=td-main><div class="row flex-xl-nowrap"><main class="col-12 col-md-9 col-xl-8 pl-md-5" role=main><div class=td-content><div class="pageinfo pageinfo-primary d-print-none"><p>This is the multi-page printable view of this section.
<a href=# onclick="return print(),!1">Click here to print</a>.</p><p><a href=/cn/docs/clients/>Return to the regular view of this page</a>.</p></div><h1 class=title>API</h1><ul><li>1: <a href=#pg-a809bf70d5493b5046619919800e4de6>HugeGraph RESTful API</a></li><ul><li>1.1: <a href=#pg-698c3217de07a8cb0dc0e93dbae29ee9>Schema API</a></li><li>1.2: <a href=#pg-f7f4b3b6f4b7a965f8c30675df8e56f8>PropertyKey API</a></li><li>1.3: <a href=#pg-28cb205879be97a55ddc8cd365c4438e>VertexLabel API</a></li><li>1.4: <a href=#pg-41864d99c39fc7040549f6eaf5441daf>EdgeLabel API</a></li><li>1.5: <a href=#pg-7099742fb947ad5dfde9e72216c10b8a>IndexLabel API</a></li><li>1.6: <a href=#pg-bde129922f801ad9560757fcec64d05c>Rebuild API</a></li><li>1.7: <a href=#pg-86bf520fd6b098231f4af6590328e871>Vertex API</a></li><li>1.8: <a href=#pg-f40127b155ddd802d50c507ff1cf5530>Edge API</a></li><li>1.9: <a href=#pg-f0adc653be0b454ce1952bdaf0afefa6>Traverser API</a></li><li>1.10: <a href=#pg-ced5167413a6606a537e40b18f6fec3e>Rank API</a></li><li>1.11: <a href=#pg-32aff6fa72d51caa846c2a72e5771c5d>Variable API</a></li><li>1.12: <a href=#pg-3d75cf337650cd90a617c3ef7e9dca87>Graphs API</a></li><li>1.13: <a href=#pg-d9de752e44e3a8a709d187e4101fd818>Task API</a></li><li>1.14: <a href=#pg-e84b0f106294b580ca64918b72cc71d1>Gremlin API</a></li><li>1.15: <a href=#pg-f7fe8b1685038d0062b4c806247e1db4>Cypher API</a></li><li>1.16: <a href=#pg-a3b125f257052209fcb98300d5c066a7>Authentication API</a></li><li>1.17: <a href=#pg-8e126d4f2f7317a1268d7edb65cd4fcc>Other API</a></li></ul><li>2: <a href=#pg-3457a7585a93814fdbb1a44b68edc0d3>HugeGraph Java Client</a></li><li>3: <a href=#pg-1ebf9ecb86d8a6b8536fd581e696ce8c>Gremlin-Console</a></li></ul><div class=content></div></div><div class=td-content><h1 id=pg-a809bf70d5493b5046619919800e4de6>1 - HugeGraph RESTful API</h1><p>HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的接口，主要包括元数据和
图数据的增删改查，遍历算法，变量，图操作及其他操作。</p></div><div class=td-content style=page-break-before:always><h1 id=pg-698c3217de07a8cb0dc0e93dbae29ee9>1.1 - Schema API</h1><h3 id=11-schema>1.1 Schema</h3><p>HugeGraph 提供单一接口获取某个图的全部 Schema 信息，包括：PropertyKey、VertexLabel、EdgeLabel 和 IndexLabel。</p><h5 id=method--url>Method & Url</h5><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>GET http://localhost:8080/graphs/{graph_name}/schema
图数据的增删改查，遍历算法，变量，图操作及其他操作。</p><p>除了下方的文档，你还可以通过 <code>localhost:8080/swagger-ui/index.html</code> 访问 <code>swagger-ui</code> 以查看 <code>RESTful API</code>。<a href=/cn/docs/quickstart/hugegraph-server#swaggerui-example>示例可以参考此处</a></p></div><div class=td-content style=page-break-before:always><h1 id=pg-698c3217de07a8cb0dc0e93dbae29ee9>1.1 - Schema API</h1><h3 id=11-schema>1.1 Schema</h3><p>HugeGraph 提供单一接口获取某个图的全部 Schema 信息，包括：PropertyKey、VertexLabel、EdgeLabel 和 IndexLabel。</p><h5 id=method--url>Method & Url</h5><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>GET http://localhost:8080/graphs/{graph_name}/schema
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span>e.g: GET http://localhost:8080/graphs/hugegraph/schema
</span></span></code></pre></div><h5 id=response-status>Response Status</h5><div class=highlight><pre tabindex=0 style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-json data-lang=json><span style=display:flex><span><span style=color:#0000cf;font-weight:700>200</span>
Expand Down
3 changes: 2 additions & 1 deletion cn/docs/clients/index.xml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>HugeGraph – API</title><link>/cn/docs/clients/</link><description>Recent content in API on HugeGraph</description><generator>Hugo -- gohugo.io</generator><atom:link href="/cn/docs/clients/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: HugeGraph RESTful API</title><link>/cn/docs/clients/restful-api/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/cn/docs/clients/restful-api/</guid><description>
&lt;p>HugeGraph-Server通过HugeGraph-API基于HTTP协议为Client提供操作图的接口，主要包括元数据和
图数据的增删改查，遍历算法，变量，图操作及其他操作。&lt;/p></description></item><item><title>Docs: HugeGraph Java Client</title><link>/cn/docs/clients/hugegraph-client/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/cn/docs/clients/hugegraph-client/</guid><description>
图数据的增删改查，遍历算法，变量，图操作及其他操作。&lt;/p>
&lt;p>除了下方的文档，你还可以通过 &lt;code>localhost:8080/swagger-ui/index.html&lt;/code> 访问 &lt;code>swagger-ui&lt;/code> 以查看 &lt;code>RESTful API&lt;/code>。&lt;a href="/cn/docs/quickstart/hugegraph-server#swaggerui-example">示例可以参考此处&lt;/a>&lt;/p></description></item><item><title>Docs: HugeGraph Java Client</title><link>/cn/docs/clients/hugegraph-client/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/cn/docs/clients/hugegraph-client/</guid><description>
&lt;p>本文的代码都是&lt;code>java&lt;/code>语言写的，但其风格与&lt;code>gremlin(groovy)&lt;/code>是非常类似的。用户只需要把代码中的变量声明替换成&lt;code>def&lt;/code>或直接去掉，
就能将&lt;code>java&lt;/code>代码转变为&lt;code>groovy&lt;/code>；另外就是每一行语句最后可以不加分号，&lt;code>groovy&lt;/code>认为一行就是一条语句。
用户在&lt;code>HugeGraph-Studio&lt;/code>中编写的&lt;code>gremlin(groovy)&lt;/code>可以参考本文的&lt;code>java&lt;/code>代码，下面会举出几个例子。&lt;/p>
Expand Down
Loading

0 comments on commit ddc7acb

Please sign in to comment.