プロジェクトの開発や保守を簡単にするために、LoopBackの標準的なプロジェクト構成を使いましょう。
Page Contents
LoopBack プロジェクトのファイルとディレクトリは、_アプリケーションルートディレクトリ_に配置されます。 このディレクトリ内で、LoopBackプロジェクト構造は3つのサブディレクトリを持ちます。
server
- Node アプリケーションスクリプトと設定ファイルclient
- クライアント用 JavaScript・HTML・CSSファイル (LoopBack ツールのみ).common
- クライアントとサーバに共通のファイル。/models
サブディレクトリはモデルのJSONとJavaScriptファイルを含みます。definitions
- API and product definition YAML files (IBM API Connect only).
Note:
クライアントとサーバで共有するモデルのJSONとJavaScriptファイルは /common/models
ディレクトリに置いてください。サーバのみのファイルは /server/models
に、クライアントのみのファイルは /client/models
に置いてください。
ファイルまたはディレクトリ | 説明 | コードからアクセスする方法 |
---|---|---|
最上位のアプリケーションディレクトリ | ||
/node-modules ディレクトリ |
package.json で指定されている依存関係の Node パッケージを含む。npm install で更新する。 |
なし |
package.json
|
標準のnpmパッケージ仕様。 package.json を参照。 | なし |
README.md |
内部文書のスタブファイル | なし |
/server ディレクトリ - Node アプリケーションファイル | ||
/boot ディレクトリ |
初期化やセットアップを行うスクリプトを追加する。起動スクリプトを参照。 | スクリプトは、アルファベット順に自動実行される。 |
/models ディレクトリ |
サーバ限定のモデル定義 | Node:myModel = |
component-config.json |
読み込むLoopBack コンポーネントを指定する。 | Strongloop ツールによってのみ作られる。API Connect では使用しない。 |
config.json |
アプリケーション設定。 config.jsonを参照。 | app.get('setting-name') |
datasources.json |
データソース設定ファイル。datasources.json参照。例は、新しいデータソースの作成を参照。 | app.datasources['datasource-name'] |
middleware.json |
ミドルウェア定義ファイル。詳細は ミドルウェア定義 を参照。 | なし |
middleware.development.json |
開発時設定のミドルウェア定義ファイル。詳細は ミドルウェア定義 を参照。 デプロイの準備を参照。 | |
model-config.json |
モデル設定ファイル。model-config.jsonを参照。詳細は、 モデルとデータソースの接続を参照。 | なし |
server.js |
メインアプリケーションプログラムファイル | なし |
/client ディレクトリ - クライアントアプリケーションファイル | ||
README.md | LoopBack 生成ツールが空の README.md ファイルを作成する。 |
なし |
その他 | HTML・CSS・クライアントJavaScriptファイルを追加する。 | |
/common ディレクトリ - 共有アプリケーションファイル | ||
/models ディレクトリ |
独自のモデルファイル:
|
注:myModel =
|
Important:
LoopBack モデル生成ツールは、自動的にキャメルケースのモデル名(例えば MyModel)を小文字ダッシュ付きの名前(my-model)に変換します。
例えば、”FooBar”という名前のモデルを作った場合、common/models
には、 foo-bar.json
と foo-bar.js
というファイルが作られます。
しかし、モデル名(“FooBar”)は、モデル名プロパティにそのまま残ります。