Kde zveřejňovat vzory užití našeho API nejen pro cool uživatele rubrika: Administrace: Software

8 Tomáš Tintěra
položil/-a 14.10.2013
 
upravil/-a 14.10.2013

Kde nejlépe zveřejnit zdrojáky ukázkových konfigurací a použití našeho API? Nejde o cool projekt jen pro cool uživatele. Jde mi spíše širší vrstvy od profi programátorů pro správce IT systémů, kteří umí využít verzovací systém.

Komentáře

  • Tomáš Tintěra : Předpokládám, že lidé budou spíše občas sledovat změny, než mít kompletní zdrojáky všech příkladů na disku a aktivně si je stahovat. — 14.10.2013
  • Anonym : O jaké API jde? — 15.10.2013
  • Tomáš Tintěra : Základ poběží na JVM. Půjde hlavně o pluginy do DB softwaru a šablony vzhledu. V systému jsou entity (lidé, úkoly, konverzace) obashující štítky a další datová pole dle konfigurace. Pluginů může být více a budou žít vlastním životem. — 15.10.2013
odkaz
9 Honza Břešťan
odpověděl/-a 14.10.2013
 
upravil/-a 14.10.2013

Pokud jde o vami hostovanou sluzbu
Nevim, jak se to resi obecne, ale .NET servicy maji by default u kazde sluzby relativni cestu "/help", kde je vygenerovany seznam vsech metod, k nim prislusne popisy a po rozkliknuti tam byva ukazka kontraktu (XSD, XML priklad, nebo JSON) a nejaky dalsi popis.

Pro predstavu to treba u ASP.NET WebAPI muze vypadat takhle http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-...

Pokud jde o knihovnu
Tam je to nejlepsi v repozitari vedle kodu, idealne v testech.
Pokud je to vazne velky projekt, mozna se vyplati zainvestovat do online dokumentace s navody, ale pokud ma za neco stat, chce to velmi dusledne dodrzovat jeji aktualizaci.

Komentáře

  • Tomáš Tintěra : Jde o SW, který jde buď najmout jako služba nebo zakoupit. Vhodné se mi zdá obojí. Repozitář pro rozsáhlejší věci (nad 10 řádků). Zde je možno vidět viděl jak se vyvíjí příklady, ze kterých jsem vyšla instalace XY. Stejně tak u konfigurací na míru, které vyrobíme. — 15.10.2013
  • Anonym : Mě se docela líbí přístup, jaký byl zvolen pro službu Fakturoid (https://github.com/fakturoid). Pokud by to nemělo být přístupné bez registrace tak mít možnost si stáhnout po přihlášení aktuální archiv s changelogem nebo pomocí API povolovat přidávat přístup (na základě registrace) pro čtení k GIT repositáři. — 15.10.2013
  • Tomáš Tintěra : Github je favoritem, nezmiňoval jsem ho v otázce, abych nenasměroval diskusi. — 16.10.2013
  • Anonym : @Tin: v našem týmu používám Bitbucket a na veřejné/ otevřené projekty Github — 16.10.2013

Pro zobrazení všech 3 odpovědí se prosím přihlaste:

Rychlé přihlášení přes sociální sítě:

Nebo se přihlaste jménem a heslem:

Zadejte prosím svou e-mailovou adresu.
Zadejte své heslo.

Aktuální otázky v rubrice Administrace: Software

Otázky uživatele Tomáš Tintěra