Criando API para módulos personalizados

Introdução

Se você criou seu próprio módulo para o ONLYOFFICE e o adicionou ao ONLYOFFICE Workspace seguindo estas instruções, você também pode criar uma API para este módulo.

Como criar API para seu próprio módulo

1. Crie um projeto de Biblioteca de Classes (ASC.Api.Sample) e coloque-o na pasta ...module\ASC.Api\ASC.Api.Sample.
   IMPORTANTE!!! O nome do arquivo dll de saída deve ser "ASC.Api.*.dll";
2. Conecte as referências necessárias de ...\web\studio\ASC.Web.Studio\bin\:

   ASC.Api.dll ASC.Web.Sample.dll

3. Crie a classe SampleApi e implemente a interface IApiEntryPoint:

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

4. Crie métodos públicos com os atributos específicos:

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

   O atributo especifica o tipo de método, o caminho pelo qual este método será chamado, a autorização e a verificação do plano tarifário nele. As opções possíveis são mostradas abaixo:

   CreateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde à solicitação "POST" UpdateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde à solicitação "PUT" DeleteAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde à solicitação "DELETE" ReadAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde à solicitação "GET"

   os parâmetros requiresAuthorization, checkPayment são opcionais e têm valor true por padrão.

5. Defina o caminho de saída nas propriedades do projeto como:

   <OutputPath>..\..\..\web\studio\ASC.Web.Studio\bin\</OutputPath> <DocumentationFile>..\..\..\web\studio\ASC.Web.Studio\bin\ASC.Api.Sample.XML</DocumentationFile>

   para que as compilações sejam criadas na pasta web\studio\ASC.Web.Studio\bin.

6. O projeto pode ser compilado manualmente ou usando o builder. Para este último, adicione as seguintes linhas ao arquivo build\msbuild\build.proj:

   <ProjectToBuild Include="$(ASCDir)module\ASC.Api\ASC.Api.Sample\ASC.Api.Sample.csproj"/>

   e execute o arquivo build\Build.bat.

7. IMPORTANTE!!! Adicione ASC.Api.Sample.SampleApi ao arquivo 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"/>

8. Compile o projeto, execute o site e teste o método fazendo uma consulta com jQuery:

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