カスタムモジュール用APIの作成

はじめに

ONLYOFFICE用に独自のモジュールを作成し、ONLYOFFICE Workspaceにこれらの手順に従って追加した場合、そのモジュール用のAPIを作成することもできます。

独自モジュール用APIの作成方法

クラスライブラリ（ASC.Api.Sample）プロジェクトを作成し、...module\ASC.Api\ASC.Api.Sampleフォルダに配置します。
重要!!! 出力dllファイル名は"ASC.Api.*.dll"でなければなりません。
必要な参照を...\web\studio\ASC.Web.Studio\bin\から接続します：
```
ASC.Api.dll
ASC.Web.Sample.dll
```

SampleApiクラスを作成し、IApiEntryPointインターフェースを実装します：

public class SampleApi : IApiEntryPoint
{
    public string Name
    {
        get { return "sample"; }
    }
}

特定の属性を持つパブリックメソッドを作成します：

[Attributes.Create("create", false)]
public SampleClass Create(string value)
{
    return SampleDao.Create(value);
}

この属性はメソッドの種類、メソッドが呼び出されるパス、認証、料金プランの確認を指定します。可能なオプションは以下の通りです：

CreateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //"POST"リクエストに対応
UpdateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //"PUT"リクエストに対応
DeleteAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //"DELETE"リクエストに対応
ReadAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //"GET"リクエストに対応

requiresAuthorization、checkPaymentパラメーターはオプションで、デフォルトではtrueです。

プロジェクトプロパティで出力パスを次のように設定します：
```
<OutputPath>..\..\..\web\studio\ASC.Web.Studio\bin\</OutputPath>
<DocumentationFile>..\..\..\web\studio\ASC.Web.Studio\bin\ASC.Api.Sample.XML</DocumentationFile>
```
これにより、ビルドがweb\studio\ASC.Web.Studio\binフォルダに作成されます。
プロジェクトは手動でビルドすることも、ビルダーを使用することもできます。後者の場合、build\msbuild\build.projファイルに次の行を追加します：
```
<ProjectToBuild Include="$(ASCDir)module\ASC.Api\ASC.Api.Sample\ASC.Api.Sample.csproj"/>
```
そしてbuild\Build.batファイルを実行します。

重要!!! ASC.Api.Sample.SampleApiをweb\studio\ASC.Web.Studio\web.autofac.configファイルに追加します：

<component
          type="ASC.Api.Sample.SampleApi, ASC.Api.Sample"
          service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
          name="sample"/>

プロジェクトをビルドし、ウェブサイトを実行して、jQueryを使用してメソッドをテストします：

$.ajax({
    type: "POST",
    url: "http://localhost:port/api/2.0/sample/create.json",
    data: {value: "create"}
});