Creación de API para módulos personalizados

Introducción

Si has creado tu propio módulo para ONLYOFFICE y lo has añadido a ONLYOFFICE Workspace siguiendo estas instrucciones, también puedes crear una API para este módulo.

Cómo crear una API para tu propio módulo

1. Crea un proyecto de Biblioteca de Clases (ASC.Api.Sample) y colócalo en la carpeta ...module\ASC.Api\ASC.Api.Sample.
   ¡IMPORTANTE! El nombre del archivo dll de salida debe ser "ASC.Api.*.dll";
2. Conecta las referencias necesarias desde ...\web\studio\ASC.Web.Studio\bin\:

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

3. Crea la clase SampleApi e implementa la interfaz IApiEntryPoint:

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

4. Crea métodos públicos con los atributos específicos:

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

   El atributo especifica el tipo de método, la ruta por la cual se llamará a este método, la autorización y la verificación del plan tarifario en él. Las opciones posibles se muestran a continuación:

   CreateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde a la solicitud "POST" UpdateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde a la solicitud "PUT" DeleteAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde a la solicitud "DELETE" ReadAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corresponde a la solicitud "GET"

   los parámetros requiresAuthorization, checkPayment son opcionales y tienen un valor de true por defecto.

5. Establece la ruta de salida en las propiedades del proyecto como:

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

   para que las compilaciones se creen en la carpeta web\studio\ASC.Web.Studio\bin.

6. El proyecto se puede compilar manualmente o utilizando el constructor. Para este último, añade las siguientes líneas al archivo build\msbuild\build.proj:

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

   y ejecuta el archivo build\Build.bat.

7. ¡IMPORTANTE! Añade ASC.Api.Sample.SampleApi al archivo 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. Compila el proyecto, ejecuta el sitio web y prueba el método realizando una consulta con jQuery:

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