Kreiranje API-ja za prilagođene module

Uvod

Ako ste kreirali svoj modul za ONLYOFFICE i dodali ga u ONLYOFFICE Workspace prateći ove instrukcije, možete takođe kreirati API za ovaj modul.

Kako kreirati API za svoj modul

1. Kreirajte projekat Class Library (ASC.Api.Sample) i postavite ga u folder ...module\ASC.Api\ASC.Api.Sample.
   VAŽNO!!! Ime izlaznog dll fajla mora biti "ASC.Api.*.dll";
2. Povežite potrebne reference iz ...\web\studio\ASC.Web.Studio\bin\:

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

3. Kreirajte klasu SampleApi i implementirajte interfejs IApiEntryPoint:

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

4. Kreirajte javne metode sa specifičnim atributima:

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

   Atribut specificira tip metode, putanju kojom će se metoda pozivati, autorizaciju i proveru tarifnog plana u njoj. Moguće opcije su prikazane ispod:

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

   parametri requiresAuthorization, checkPayment su opcionalni i po defaultu imaju vrednost true.

5. Podesite putanju izlaza u svojstvima projekta kao:

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

   tako da se buildovi kreiraju u folderu web\studio\ASC.Web.Studio\bin.

6. Projekat se može izgraditi ručno ili korišćenjem builder-a. Za ovo drugo dodajte sledeće linije u fajl build\msbuild\build.proj:

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

   i pokrenite fajl build\Build.bat.

7. VAŽNO!!! Dodajte ASC.Api.Sample.SampleApi u fajl 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. Izgradite projekat, pokrenite vebsajt i testirajte metodu pravljenjem upita sa jQuery:

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