Creare API per moduli personalizzati

Introduzione

Se hai creato il tuo modulo per ONLYOFFICE e lo hai aggiunto a ONLYOFFICE Workspace seguendo queste istruzioni, puoi anche creare un'API per questo modulo.

Come creare un'API per il tuo modulo

1. Crea un progetto Class Library (ASC.Api.Sample) e posizionalo nella cartella ...module\ASC.Api\ASC.Api.Sample.
   IMPORTANTE!!! Il nome del file dll di output deve essere "ASC.Api.*.dll";
2. Collega i riferimenti richiesti da ...\web\studio\ASC.Web.Studio\bin\:

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

3. Crea la classe SampleApi e implementa l'interfaccia IApiEntryPoint:

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

4. Crea metodi pubblici con attributi specifici:

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

   L'attributo specifica il tipo di metodo, il percorso tramite il quale questo metodo verrà chiamato, l'autorizzazione e la verifica del piano tariffario in esso. Le opzioni possibili sono mostrate di seguito:

   CreateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corrisponde alla richiesta "POST" UpdateAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corrisponde alla richiesta "PUT" DeleteAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corrisponde alla richiesta "DELETE" ReadAttribute(string path, bool requiresAuthorization = true, bool checkPayment = true) //corrisponde alla richiesta "GET"

   i parametri requiresAuthorization, checkPayment sono opzionali e hanno un valore di true per impostazione predefinita.

5. Imposta il percorso di output nelle proprietà del progetto come:

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

   in modo che le build vengano create nella cartella web\studio\ASC.Web.Studio\bin.

6. Il progetto può essere costruito manualmente o utilizzando il builder. Per quest'ultimo, aggiungi le seguenti righe al file build\msbuild\build.proj:

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

   e esegui il file build\Build.bat.

7. IMPORTANTE!!! Aggiungi ASC.Api.Sample.SampleApi al file 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. Costruisci il progetto, esegui il sito web e testa il metodo effettuando una query con jQuery:

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