Skip to content
This repository was archived by the owner on Aug 8, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Vironは運用管理画面という役割も持って、ユーザとProjectの

![endpoint](endpoint.png)

ProjectAは[OpenAPI Specification ver2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)のAPI定義書(例: GET /swagger.json)と認証方法(GET /viron_authtype)を公開しています。Vironはこれら2つの情報を元に画面上にエンドポイントカード(EndpointA)を表示します。Projectとエンドポイントカードは対になっており、仮に環境(stagingやproduction)別にProjectが存在する場合はその環境数だけエンドポイントカードが必要になります。
ProjectAは[OpenAPI Specification ver2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)のAPI定義書(例: GET /swagger.json)と認証方法(GET /viron/authtype)を公開しています。Vironはこれら2つの情報を元に画面上にエンドポイントカード(EndpointA)を表示します。Projectとエンドポイントカードは対になっており、仮に環境(stagingやproduction)別にProjectが存在する場合はその環境数だけエンドポイントカードが必要になります。

ユーザから見ると、エンドポイントカードはProjectへの玄関口になります。エンドポイントカードは、Projectが公開する認証方法(GET /viron_authtype)でユーザ認証を行うため、許可されていないユーザは玄関を開けることが出来ません。
ユーザから見ると、エンドポイントカードはProjectへの玄関口になります。エンドポイントカードは、Projectが公開する認証方法(GET /viron/authtype)でユーザ認証を行うため、許可されていないユーザは玄関を開けることが出来ません。

### Projectページ

Expand Down
2 changes: 1 addition & 1 deletion docs/dev_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: 必須API

Vironサーバを開発するにあたって、まず3つのAPIを作成する必要があります。

- 認証方式を取得する `/viron_authtype`
- 認証方式を取得する `/viron/authtype`
- swaggerを取得する `/swagger.json`
- グローバルメニューを取得する `/viron`

Expand Down
10 changes: 5 additions & 5 deletions docs/dev_api_authtype.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ id: dev_api_authtype
title: 必須API: 認証方式の取得
---

サーバがサポートする認証方式の一覧を取得するAPIです。
アプリ側では受け取った一覧を元にログイン画面を生成します。
URLは `GET: /viron_authtype` 固定で、非認証状態でコールできる必要があります。
サーバがサポートする認証方式の一覧を取得するAPIです。
アプリ側では受け取った一覧を元にログイン画面を生成します。
URLは `GET: /viron/authtype` 固定で、非認証状態でコールできる必要があります。

### authtype controller

`controllers/viron_authtype.js` に `auth_type#list` という名前でcontrollerを実装します。
下記インタフェースでAPIを実装してください。
`controllers/viron_authtype.js` に `auth_type#list` という名前でcontrollerを実装します。
下記インタフェースでAPIを実装してください。
[example-emailのサンプル](https://github.com/cam-inc/viron/blob/develop/example-email/controllers/viron_authtype.js)

```javascript
Expand Down