apice

README

APICE

概要

「APICE（アピーチェ）」は、API利用者に向けてAPIドキュメントを公開するためのWebアプリケーションです。 OpenAPI Specで記載されたAPI設計書を見やすく表示することができます。以下の画面が利用可能です。

• ダッシュボード画面
• サイト利用者向けの更新情報 / 障害情報の表示
• API一覧画面、API詳細画面の表示
• API利用規約などドキュメントの表示
• カテゴリとタグを使ったAPIの整理
• 関連サイトへのリンク表示
• ユーザ、グループ、ロールの管理

利用方法

Docker Composeを使ってコンテナを起動するのが簡単です。

docker-compose build
docker-compose up -d

コンテナが起動したら、 http://localhost:3000 にブラウザでアクセスするとトップページが表示されます。 初期ユーザは admin / password です。

ライセンス

このソフトウェアは Apache License, Version 2.0 で公開されています。