*

nissmick · Nov 25, 2023 · 5450aab · 5450aab
1 parent 0ef9224
commit 5450aab
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/docs.yaml b/docs.yaml
@@ -3,16 +3,20 @@ openapi: "3.0.3"
 info:
   title: "Nissmick API"
   version: "0.0.0"
-
+servers:
+  - url: https://nissmick.net/api/v1
+tags:
+  - name: "users"
+    description: "ユーザー関連"
 paths:
-  "/api/v1/hello":
+  "/users/{id}/display_name":
     get:
-      summary: "hello"
+      summary: "display_nameを取得"
       responses:
         "200":
           description: "成功"
           content:
             application/json:
               schema:
                 type: string
-                example: "hello"
+                example: "nissmick"
diff --git a/docs/index.html b/docs/index.html
@@ -2109,9 +2109,9 @@
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
         " fill="currentColor"></path></g></svg></div></div><div class="sc-jtiXyc kRuFuS api-content"><div class="sc-eCApnc jlMQbh"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod api-info"><h1 class="sc-fujyAs sc-dFRpbK bpZWeL fdKBSs">Nissmick API<!-- --> <span>(<!-- -->0.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-bsatvv gidAUi">Download</a></p><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV"></div><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV" data-role="redoc-summary"></div><div class="sc-iJCRrE sc-ciSkZP jCdxGr QGruV" data-role="redoc-description"></div></div></div></div><div id="/paths/~1api~1v1~1hello/get" data-section-id="/paths/~1api~1v1~1hello/get" class="sc-eCApnc liLqNm"><div class="sc-iCoGMd gLxhOh"><div class="sc-hKFxyN juinod"><h2 class="sc-pNWdM eftmgB"><a class="sc-crzoAE iUxAWq" href="#/paths/~1api~1v1~1hello/get" aria-label="/paths/~1api~1v1~1hello/get"></a>hello<!-- --> </h2><div><h3 class="sc-fIxmyt DvFer">Responses</h3><div><button class="sc-htmcrh lbYftx"><svg class="sc-dIsUp dqYXmg" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fWWYYk cMoEZ">200<!-- --> </strong><span class="sc-jcwpoC eDjFAZ"><p>成功</p>
-</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/api/v1/hello</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span></span>/api/v1/hello</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><span class="token string">&quot;hello&quot;</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-ellfGf bgakXB"></div></div></div>
+</span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy gBjRyf gcushC"><div class="sc-EZqKI fWsqvQ"><button class="sc-eEVmNe ilvUMs"><span type="get" class="sc-fmdNqN ihNycv http-verb get">get</span><span class="sc-jXcxbT fCEUju">/api/v1/hello</span><svg class="sc-dIsUp bRmrKA" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ljsmAU flIrdF"><div class="sc-jlZJtj fQkroN"><div class="sc-iJCRrE sc-ciSkZP jCdxGr lhENGb"></div><div tabindex="0" role="button"><div class="sc-dTSzeu dfUAUz"><span>https://nissmick.net/api/v1</span>/api/v1/hello</div></div></div></div></div><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxNHIi gxohHo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-Arkif jojbRz"><span class="sc-cOifOu hlhNtL">Content type</span><div class="sc-bBjRSN kQSIAz">application/json</div></div><div class="sc-jgPyTC dSaTNC"><div class="sc-jNnpgg esZIbL"><div class="sc-giAqHp hMPeqJ"><button><div class="sc-carFqZ UksDl">Copy</div></button></div><div class="sc-iJCRrE jCdxGr sc-dPaNzc gyljjx"><div class="redoc-json"><code><span class="token string">&quot;hello&quot;</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-ellfGf bgakXB"></div></div></div>
     <script>
-    const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Nissmick API","version":"0.0.0"},"paths":{"/api/v1/hello":{"get":{"summary":"hello","responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"string","example":"hello"}}}}}}}},"components":{}}},"searchIndex":{"store":["/paths/~1api~1v1~1hello/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.288]],["description/0",[1,0.288]]],"invertedIndex":[["api/v1/hello",{"_index":1,"title":{},"description":{"0":{}}}],["hello",{"_index":0,"title":{"0":{}},"description":{}}]],"pipeline":[]}},"options":{}};
+    const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.3","info":{"title":"Nissmick API","version":"0.0.0"},"servers":[{"url":"https://nissmick.net/api/v1"}],"paths":{"/api/v1/hello":{"get":{"summary":"hello","responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"string","example":"hello"}}}}}}}},"components":{}}},"searchIndex":{"store":["/paths/~1api~1v1~1hello/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.288]],["description/0",[1,0.288]]],"invertedIndex":[["api/v1/hello",{"_index":1,"title":{},"description":{"0":{}}}],["hello",{"_index":0,"title":{"0":{}},"description":{}}]],"pipeline":[]}},"options":{}};
 
     var container = document.getElementById('redoc');
     Redoc.hydrate(__redoc_state, container);