Мени

Како створити АПИ документацију у поштару?

how create api documentation postman

Испробајте Наш Инструмент За Елиминисање Проблема

Овај водич објашњава како створити добру, стилизовану документацију уз минималне напоре користећи АПИ подршку за документацију коју пружа Постман Тоол:

За било који АПИ, било интерни или јавни, документација је један од најважнијих састојака за његов успех.

Главни разлог за то је што је документација начин на који комуницирате са својим корисницима.

  • Како треба користити ваш АПИ?
  • Који су сви статусни кодови подржани?
  • Који су кодови грешака?
  • Који су све типови метода изложени?

Све ове информације су потребне свима да би користили или применили АПИ за жељену потребу.

=> Овде припазите на једноставну серију обука за поштаре.

Поштар - Стварање АПИ документације

софтвери за преузимање видео снимака са ИоуТубе-а

Поштар пружа методологију документације која се лако користи, а за основну документацију једноставна је попут клика на дугме кроз колекцију Поштара и можете добити јавни УРЛ за своју АПИ документацију.

Шта ћете научити:

Креирање АПИ документације у поштару

Карактеристике документације

Истакнуте карактеристике генератора документације за Поштара укључују:

  • Подржава синтаксу означавања. Маркдовн је синтакса генеричке документације, коју бисте обично требали приметити на било ком Гитхуб пројекту. Омогућава да стил и обликовање текста буду познатији и лакши.
  • Нема специфичне синтаксе / захтева за креирање документације. Информације о захтевима и прикупљању користе се на најбољи начин за генерисање документације.
  • Може се објавити на јавном УРЛ-у или на прилагођеном домену (за корпоративне кориснике).
  • Генерише исечке кода за позивање АПИ-ја на различитим језицима као што су Ц #, ПХП, Руби, Питхон, Ноде итд.

Креирање документације

Поштарски генератор докумената односи се на збирку, фасциклу и опис појединачног захтева и упоређује их док ствара или генерише документацију за колекцију.

Користи разне параметре захтева као што су заглавља, параметри низа упита, параметри обрасца и указује на употребу ових вредности у документацији захтева.

Ево видео упутства:

Направимо основну колекцију са 3 захтева користећи исти тест АПИ као и наши други чланци. Додаћемо неке информације у опис збирке, као и у појединачне захтеве, а такође ћемо створити неке примере захтева и одговора, који ће такође бити забележени током креирања документације.

Следите кораке у наставку да бисте додали основне информације о захтевима, а затим креирали документацију.

# 1) Направите колекцију са 3 захтева, тј. Региструјте корисника, пријавите се и преузмите корисника (погледајте овде за корисна оптерећења захтева и АПИ УРЛ-ове).

#два) Хајде сада да додамо неке информације у формату смањења у колекцију. Маркдовн је стандардни формат који се користи за готово сву документацију у Гитхуб-у (За више информација о умањивању погледајте овде ).

У опис колекције додаћемо неке информације у формату умањења, као што је доле наведено.

Опис колекције у формату умањења вредности

Да бисте прегледали како изгледа умањење, погледајте веб портал отвореног кода овде.

Маркдовн документација

# 3) Сада ћемо описе додати појединачним захтевима у колекцији. Слично збирци, формат умањења је подржан и за описе захтева (За детаљније информације о водичу за умањење, погледајте овде ).

Погледајмо узорак једног од захтева за крајњу тачку Региструј корисника (Исто се може применити и на друге захтеве).

Маркдовн Тект:

API endpoint to *Register* a user in the system. > A successful registration will result in a *HTTP 200* Status code

Маркдовн преглед:

Маркдовн Превиев

# 4) За све АПИ крајње тачке, снимимо или сачувајмо пример који би користио генератор документације.

Примјер није ништа друго него узорак захтјева-одговора за АПИ захтјев који се разматра. Чување одговора као примера омогућава генератору документације да га ухвати као део саме документације.

Да бисте сачували пример, притисните „Пошаљи“ дугме за извршење захтева и на картици одговора кликните Саве Респонсе -> Саве ас Екампле .

Сачувај пример

Једном када је пример сачуван, он се задржава у колекцији и може му се приступити било када у будућности путем Примери везу у градитељу захтева.

# 5) Када се додају све горе наведене информације, погледајмо како да направимо преглед документације.

Отворите опције сакупљања и кликните „ Објави документе ”.

Објави документе

Белешка: Овде је важно напоменути да ће само регистровани корисници са Постман-ом моћи да користе функцију Публисх доцс на Постман-у. Регистрација је бесплатна, али је потребно извршити путем вашег налога е-поште. Постоје и друге могућности / функције као што су дељење колекција и радних простора, стварање монитора итд., Које се додају на регистроване налоге.

# 6) Једном ' Објави документе ”Се извршава, отвара се картица прегледача са детаљима колекције поштара (поштар интерно хостује ову колекцију на сопственим серверима, поред корисничког локалног система датотека).

Збирка документације

Кликните на „Преглед“ да бисте погледали документацију пре него што буде објављена.

' Објави збирку ”Линк ће објавити документацију на јавно доступном УРЛ-у. Генерално се не препоручује објављивање АПИ-ја са осетљивим информацијама о овлашћењу за објављивање на јавном УРЛ-у. Такви АПИ-ји се могу објавити помоћу прилагођених домена са поштанским рачунима предузећа.

# 7) Погледајмо како изгледа преглед документације. Клик “ Преглед документације ”Отвара документацију у режиму прегледа који је хостован на поштарским серверима. Погледајмо који су различити детаљи забележени у документацији (Као што смо конфигурисали на различитим местима. На пример , опис колекције, опис захтева и примери).

Узорак документације поштара

Опис захтева у Маркдовн-у

На горња 2 снимка екрана можете видети да су све информације које су додате у збирку и описи захтева у прегледу документације ухваћене на начин означен стилом.

како да покренем свф датотеке

Такође, документација по дефаулту нуди језичке везе као што је истакнуто и то олакшава некоме ко жели директно да АПИ захтев захтева на наведеном језику.

# 8) Такође вам омогућава да изводите врло основне модификације стила као што су промена боје позадине, промена боје позадине и предњег плана шаблона заглавља итд. Али у целини, задани приказ сам по себи довољан је за објављивање заиста доброг скупа документације која обухвата много важни детаљи о АПИ-ју.

Закључак

У овом упутству смо прошли кроз подршку за АПИ документацију коју пружа Постман, помоћу које уз минимални напор можемо створити документацију доброг изгледа.

Такође омогућава мноштво добрих шаблона и кориснички дефинисан стил који се може применити на генерисане документе, а такође омогућава објављивање документације на јавном УРЛ-у.

За приватне АПИ крајње тачке, такође постоји одредба о објављивању документације на прилагођеном домену који може бити конфигурисан за пословне налоге или кориснике.

Даље читање = >> Како објавити уговор о уговору за Пацт Брокер

=> Посетите овде да бисте поштара научили испочетка.

Препоручено читање

^