github rest api tutorial rest api support github
ГитХуб РЕСТ АПИ - Интерфејс за програмску интеракцију са ГитХуб-ом:
У нашим ранијим водичима о ГитХуб-у истражујемо различите аспекте употребе из перспективе програмера помоћу веб интерфејса.
Данас већина организација истражује могућности аутоматизације у скоро свим областима, а РЕСТ АПИ-ји су корисни за аутоматизацију различитих сценарија за различите алате.
Наравно, могу постојати и друга подручја у којима би РЕСТ АПИ могли да се користе.
=> Посетите овде за ексклузивну серију ГитХуб Траининг Туториал .
Шта ћете научити:
ГитХуб РЕСТ АПИ интеграција
АПИ-ји РЕСТ (Репрезентативни пренос државе) првенствено користе ХТТП захтеве да би урадили следеће.
- ДОБИТИ - Преузми ресурс
- ПУТ / ПАТЦХ - Ажурирање ресурса
- ПОШТА - Направите ресурс
- ИЗБРИШИ - Избриши ресурс
Нећемо зарањати дубоко у то како функционише РЕСТ АПИ, већ ћемо директно ускочити у подршку за РЕСТ АПИ у ГитХуб-у користећи ЗАВИЈАЊЕ наредба за извршавање већине задатака које смо видели у нашим претходним водичима на ГитХуб-у путем РЕСТ АПИ-ја.
Тренутна верзија ГитХуб АПИ-ја је в3 и овај водич покрива најважније активности које би програмеру требале путем ових АПИ-ја.
Креирање личног приступног токена
Да би РЕСТ АПИ функционисао кроз командну линију, морамо да се аутентификујемо на ГитХуб серверу. Због тога морамо да пружимо своја документа. Па, не желимо да излажемо лозинку која се користи са нашим ГитХуб налогом, па ћемо генерисати лични токен за приступ који ће се користити са командном линијом за потврду идентитета на ГитХуб.
Пријавите се на свој ГитХуб налог и кликните на Подешавања испод вашег профила.
Иди на Подешавања програмера -> Токени личног приступа. Генеришите нови токен.
Додајте име и одаберите опсег за приступ АПИ-ју и кликните на Направите жетон.
На следећем екрану обавезно копирајте токен и сачувајте га у датотеци. Овај токен ће се користити у командној линији за приступ ГитХуб АПИ-ју.
најбољи додатак за блокирање искачућих прозора хром
Креирани токен се такође може користити током гит клон операција када се тражи лозинка. Сада, пошто имамо токен, видећемо како приступити АПИ-ју из командне линије помоћу програма ЦУРЛ.
Као предуслов, мораћете да преузмете и инсталирате ‘Увијање’ .
Репозиторијум
Овде приказани примери РЕСТ АПИ-а покрећу се на Виндовс машини. Овај одељак ће приказати неке од операција ГитХуб Репозиторија.
# 1) Да бисте пописали јавна складишта за корисника, покрените следећу наредбу у једном реду.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/усерс//репос |. | греп -в клон_урл
#два) Да бисте навели јавне репозиторијуме под организацијом.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/оргс//репос |. | греп -в клон_урл
# 3) Направите лично спремиште.
цурл -Кс ПОСТ -у: хттпс://апи.гитхуб.цом/усер/репос -д “{” наме ”: ” Демо_Репо ”}”
У горњем имену команде је параметар. Погледајмо неке друге параметре који се могу користити приликом креирања личних корисничких спремишта.
цурл -Кс ПОСТ -у: хттпс://апи.гитхуб.цом/усер/репос -д “{” назив ”: ” Демо_Репо ”, ” опис ”: ” Ово је прво репо путем АПИ-ја ”, ” почетна страница ”: ” хттпс: //гитхуб.цом ” , 'Јавно ': 'тачно ', 'има_издања ': 'тачно ', 'има_пројекте ': 'тачно ', 'хас_вики ': 'тачно '} '
У горњој наредби, име, опис, почетна страница, јавно, хас_пројецтс, хас_вики су сви параметри који узимају вредност низа и затворени су у ”. Такође имајте на уму да постоји ПРОСТОР између: и
На пример, јавни параметар чини репо јавним. Команда такође омогућава креирање издања, пројеката, викија.
# 4) Преименујте Спремиште.
цурл -Кс ПОСТ -у: -Кс ПАТЦХ -д “{” наме ”: ” ”}” хттпс://апи.гитхуб.цом/репос//
# 5) Ажурирајте хас_вики параметар у спремишту и поставите вредност на фалсе.
цурл -у: -Кс ПАТЦХ -д “{” хас_вики ”: ” фалсе ”}” хттпс://апи.гитхуб.цом/репос/усер-наме/
# 6) Избришите Спремиште.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос//
# 7) Направите спремиште у организацији.
цурл -Кс ПОСТ -у: хттпс://апи.гитхуб.цом/оргс//репос “{” Наме ”: ” Демо_Репо_Ин_Орг ”, ” десцриптион ”: ” Ово је први репо у организацији путем АПИ-ја ”, ” почетна страница ”: ” хттпс: //гитхуб.цом ” , 'Јавно ': 'тачно ', 'има_издања ': 'тачно ', 'има_пројекте ': 'тачно ', 'хас_вики ': 'тачно '} '
# 8) Лист Форкс за спремиште.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///форкс |. | греп -в хтмл_урл
Горња команда ће навести УРЛ за преглед форкног репо-а. Исто се може видети и под корисничким спремиштем и ‘Картица Увид => Виљушке’ .
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///форкс |. | греп -в клон_урл
Горња команда ће навести УРЛ за клонирање рачвастог репо-а.
# 9) Осигурајте спремиште у организацији.
цурл -Кс ПОСТ -у: -д “{” организација ”: ” ”}” хттпс://апи.гитхуб.цом/репос///форкс
Сарадници
# 1) Наведите сараднике за спремиште.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///цоллабораторс |. | греп -в пријава
#два) Проверите да ли се корисник налази на листи сарадника.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///цоллабораторс/
Ако је корисник део сарадника, тада се садржај не приказује као излаз, у супротном се приказује следећа порука.
{
„Мессаге“: „није корисник“,
“Доцументатион_урл”: „хттпс://девелопер.гитхуб.цом/в3/репос/цоллабораторс/#гет”
}
# 3) Проверите дозволу корисника.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///цоллабораторс/
# 4) Додајте корисника као Сарадника у Спремиште.
цурл -Кс ПУТ -у: хттпс://апи.гитхуб.цом/репос///цоллабораторс/
Објави ово, позвани ће морати да прихвати позив да се придружи као сарадник. Ако је корисник већ додат као сарадник, тада се не приказује никакав садржај, осим излаза.
# 5) Уклањање корисника као сарадника.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос///цоллабораторс/
Једном када се наредба успешно изврши, не приказује се никакав садржај.
Организација
Напомена: ГитХуб АПИ не омогућава креирање организација.
# 1) Наведите све налоге организације за корисника.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос/усер/оргс |. | греп -в пријава
#два) Ажурирајте организацију.
цурл -Кс ПАТЦХ -у: -д “{” наме ”: ” ТеамВН ”, ” биллинг_емаил ”: ” внирањан72@оутлоок.цом ”, ” емаил ”: ” внирањан72 @ оутлоок .цом ”, ” локација ”: ” Бангалоре ”, ” ”опис ”: ”Ажурирање детаља о организацији ”} ”хттпс://апи.гитхуб.цом/оргс/
Подружнице
# 1) Наведи гране у корисничком спремишту. Команда ће навести све гране у спремишту.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///бранцхес |. | греп -в име
#два) Наведите све заштићене гране у корисничком спремишту.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///бранцхес ? заштићено = тачно | греп -в име
# 3) Наведите све незаштићене гране у корисничком спремишту
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///бранцхес ? протецтед = фалсе | греп -в име
# 4) Уклоните заштиту гране.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос///бранцхес/мастер/протецтион
Захтеви за повлачење
# 1) Листа захтева за повлачење.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///пуллс?стате=опен |. | греп -в наслов
Опције за параметар стања су Отворено, Затворено, Све.
#два) Направите захтев за повлачење.
цурл -Кс ПОСТ -у: -д “{” наслов ”: ” Додата је сјајна карактеристика ”, ” тело ”: ” Повуците велику промену направљену у главну грану ”, ” глава ”: ” Карактеристика ”, ” база ”: ” мастер ”}” хттпс://апи.гитхуб.цом/репос///пуллс
# 3) Наведите број креираних захтева за повлачење.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///пуллс?стате=опен |. | греп -в број
# 4) Ажурирајте тело захтева за повлачење или било који други параметар (максимално 250 урезивања).
цурл -Кс ПАТЦХ -у: -д “{” боди ”: ” Обавезно повући велику промену у грани обележја у главну грану ”}” хттпс://апи.гитхуб.цом/репос///пуллс / 31
# 5) Листа повлачења захтева за повлачењем.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///пуллс/31/цоммитс
# 6) Датотеке захтева за повлачење пописа (највише 300 датотека).
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///пуллс/31/филес |. | греп -в име датотеке
# 7) Споји захтев за повлачење.
цурл -Кс ПУТ -у: -д “{” цоммит_мессаге ”: ” Гоод цоммит ”}” хттпс://апи.гитхуб.цом/репос///пуллс/31 / крени
Одговор ако се споји
{
'Сха': 'е5дб2це465ф48ада4адфб571цца2д6цб859а53ц6',
„Спојено“: тачно,
„Мессаге“: „Захтев за повлачење је успешно обједињен“
}
Одговор ако се захтев за повлачење не може спојити
{
„Мессаге“: „Захтев за повлачење се не може спојити“,
“Доцументатион_урл”: „хттпс://девелопер.гитхуб.цом/в3/пуллс/#мерге-а-пулл-рекуест-мерге-буттон”
}
Ознаке, прекретнице и издања
Ознаке
# 1) Наведите све ознаке у спремишту.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///лабелс |. | греп -в име
#два) Наведите одређену ознаку у спремишту.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///лабелс / буг
# 3) Да бисте креирали етикету.
цурл -Кс ПОСТ -у: -д “{” назив ”: ” дефект ”, ” опис ”: ” За подизање квара ”, ” боја ”: ” фф493б '}' хттпс://апи.гитхуб.цом/репос///лабелс
Хексадецимални код боје за боја параметар се може поставити из Боја-хек
# 4) Ажурирај ознаку
цурл -Кс ПАТЦХ -у: -д “{” боја ”: ” 255б89 ”}” хттпс://апи.гитхуб.цом/репос///лабелс / дефект
# 5) Избриши ознаку
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос/внирањан1972/Демо_Пројецт_Репо_ВН/лабелс/дефецт
Питања
# 6) Наведите одређено издање у спремишту.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///иссуес/20 |. | греп -в наслов
# 7) Наведите све проблеме у спремишту.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///иссуес |. | греп -в наслов
# 8) Направите проблем.
цурл -Кс ПОСТ -у: -д “{” наслов ”: ” Нова страница добродошлице ”, ” тело ”: ” За дизајн нове странице ”, ” налепнице ”: (” побољшање '), ' прекретница ': ' 3 ', ' примаоци ': (' ', '
У горњој команди, етикете и асигнати параметри су низ низова у којима се може обезбедити више вредности. Стање параметар ће имати вредност отворен или затворен.
# 9) Додајте ознаку издању.
цурл -Кс ПОСТ -у: -д “{” ознаке ”: (” побољшање ”)}” хттпс://апи.гитхуб.цом/репос///иссуес / 30 / етикете
# 10) Уредите проблем и ажурирајте параметре На пример, Ознаке.
цурл -Кс ПАТЦХ -у: -д “{” ознаке ”: (” грешка ”, ” побољшање ”)}” хттпс://апи.гитхуб.цом/репос///иссуес / 30
У горњој наредби ажурирајте ознаке за број 30.
#Једанаест) Уклоните ознаку са одређеног проблема.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос///иссуес/30/лабелс/буг
# 12) Уклоните СВЕ налепнице из одређеног проблема.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос///иссуес/30/лабелс
Прекретнице
# 13) Наведите све прекретнице.
цурл -Кс ГЕТ -у: -д “{” стање ”: (” отворено ”)}” хттпс://апи.гитхуб.цом/репос///милестонес |. | греп -в наслов
# 14) Наведите детаље одређене прекретнице.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///милестонес / 1 | греп -в наслов
# петнаест) Створите прекретницу.
цурл -Кс ПОСТ -у: -д '{' наслов ': ' Р5 ', ' стање ': ' отворено ', ' опис ': ' Траг за прекретницу Р5 ', ”Због_на ”: ”2019-12-05Т17: 00: 01З ”} ” хттпс://апи.гитхуб.цом/репос///милестонес
У горњој команди дуе_он је временска ознака ИСО 8601 у ГГГГ-ММ-ДДТХХ: ММ: ССЗ формат. Више о овоме можете пронаћи на @ ИСО 8601
# 16) Ажурирајте прекретницу.
цурл -Кс ПАТЦХ -у: -д “{” стање ”: ” затворено ”}” хттпс://апи.гитхуб.цом/репос///милестонес / 3
# 17) Избришите прекретницу.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/репос///милестонес / 3
Тимови
# 1) Наведи тимове у организацији.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/оргс//теамс |. | греп -в име
Листа према ИД-у тима
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/оргс//теамс |. | греп -в ид
#два) Списак тимова према кориснику.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/усер/теамс |. | греп -в име
# 3) Направите тим, додајте чланове и додајте спремиште у тим.
цурл -Кс ПОСТ -у: -д “{” назив ”: ” ”, ” опис ”: ” Унесите кратки опис ”, ” одржавачи ”: (” ”), ”Репо_намес ”: ( ”/ ”)} ” хттпс://апи.гитхуб.цом/оргс/Демо-Прој-Орг/теамс
# 4) Измените име и опис тима.
цурл -Кс ПАТЦХ -у: -д “{” назив ”: ” Ново име тима ”, ” опис ”: ” Најновији опис ”}” хттпс://апи.гитхуб.цом/теамс/
ИД тима се може добити покретањем команде из корака 1.
# 5) Додајте спремиште постојећем тиму ..
разлика између стратегије испитивања и плана испитивања
цурл -Кс ПУТ -у: хттпс://апи.гитхуб.цом/теамс//репос//
# 6) Уклоните спремиште из тима.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/теамс/
# 7) Избриши тим.
цурл -Кс ДЕЛЕТЕ -у: хттпс://апи.гитхуб.цом/теамс/
Претражите спремишта, код, издања
АПИ за претрагу омогућава претрагу било које ставке.
# 1) На пример, ако желите да претражите сва спремишта у власништву одређеног корисника.
цурл -Кс ГЕТ хттпс://апи.гитхуб.цом/сеарцх/репоситориес?к=усер: |. | греп -в „име“
Обавезни параметар је Шта која садржи критеријуме претраге који се састоје од кључних речи и квалификатора за ограничавање претраживања у одређеној области у Гитхуб-у.
#два) Претражите сва спремишта у власништву одређеног корисника која садрже речи В и Нирањан у датотеци РЕАДМЕ
цурл -Кс ГЕТ хттпс://апи.гитхуб.цом/сеарцх/репоситориес?к=В+Нирањан+ин:реадме+усер: |. | греп -в име
# 3) Потражите кључну реч у садржају датотеке. У доњем примеру, претражите кључну реч „Систем“ и „аддЕффициее“ у датотеци у спремишту у власништву корисника.
цурл -Кс ГЕТ хттпс://апи.гитхуб.цом/сеарцх/цоде?к=Систем+аддЕффициее+ин:филе+лангуаге:јава+репо:/ |. | греп -в име
# 4) Потражите кључну реч „добродошли“ у оквиру отворених издања и означите као побољшање.
цурл -Кс ГЕТ хттпс://апи.гитхуб.цом/сеарцх/иссуес?к=велцоме+лабел:енханцемент+стате:опен+репо:/
# 5) Потражите кључну реч „адреса“ у оквиру затворених издања и означите као побољшање.
цурл -Кс ГЕТ хттпс://апи.гитхуб.цом/сеарцх/иссуес?к=аддресс+лабел:енханцемент+стате:цлосед+репо:/
Издања
# 1) Листа издања у спремишту према имену ознаке и ИД-у.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес |. | греп -в име_тага
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес |. | греп -в ид
#два) Сазнајте детаље о једном издању.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес / | греп -в име_тага
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес / | греп -в тело
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес / | греп -в име
# 3) Сазнајте детаље о НАЈНОВИЈЕМ издању.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес/латест |. | греп -в име_тага
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес/латест |. | греп -в име
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес/латест |. | греп -в тело
# 4) Дознајте детаље о издању путем Тага.
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес/т агс / | греп -в име
цурл -Кс ГЕТ -у: хттпс://апи.гитхуб.цом/репос///релеасес/т агс / | греп -в тело
# 5) Направите издање.
цурл -Кс ПОСТ -у: -д “{” име_тага ”: ” Р3.0 ”, ” таргет_цоммитисх ”: ” мастер ”, ” наме ”: ” Издање 3.0 ”, ”Боди ”: ”Ово је за издање 3.0 производа ”, ”драфт ”: “фалсе”, ”пререлеасе ”: “фалсе”} ” хттпс://апи.гитхуб.цом/репос//
Белешка:У наредби за креирање издања параметри „драфт“ и „пререлеасе“ узимају логичке вредности. Унесите тачно или нетачно без ”.
- Вредност нацрта фалсе значи да је објављено издање креирано, а тачно је необјављено издање.
- Пререлеасе фалсе значи да је пуна верзија. Права вредност значи да је пререлеасе.
# 6) Уредите или ажурирајте издање.
цурл -Кс ПАТЦХ-у: -д “{” назив_тага ”: ” Р3.1 ”}” хттпс://апи.гитхуб.цом/репос//
# 7) Избришите издање.
цурл -Кс ДЕЛЕТЕ-у: хттпс://апи.гитхуб.цом/репос//
# 8) Наведите средства за издање.
цурл -Кс ДЕЛЕТЕ-у: хттпс://апи.гитхуб.цом/репос//
Закључак
У овом водичу за ГитХуб РЕСТ АПИ видели смо како се РЕСТ АПИ могу користити за разне радње за ГЕТ, ПУТ, ПОСТ, ПАТЦХ, ДЕЛЕТЕ податке.
УРЛ адреса која се користи за РЕСТ АПИ-је за директан рад са ГитХуб.цом је хттпс://апи.гитхуб.цом. Док, ако тимови користе ГитХуб Ентерприсе у својој организацији, онда би УРЛ који се користи са РЕСТ АПИ био хттпс: /// апи / в3
Сви водичи у овој серији до сада су се концентрисали на употребу ГитХуб-а из перспективе програмера, заједно са најбољим праксама сарадње током рада у тиму за контролу верзија различитих врста артефаката директно на ГитХуб-у, а не локално.
Наш предстојећи водич ће се фокусирати на то како ће програмер радити ван мреже на локалном спремишту клонираном из ГитХуб-а користећи Гит Цлиент интерфејсе попут ГитХуб Десктоп и ТортоисеГит и вратите промене у удаљено спремиште.
=> Посетите овде да бисте ГитХуб научили од нуле.
Препоручено читање
- Водич за АПИ за одмор: РЕСТ АПИ архитектура и ограничења
- Кодови одговора на АПИ за одмор и врсте захтева за одмор
- Водич за програмере за ГитХуб | Како се користи ГитХуб
- РЕСТ АПИ тестирање са краставцем применом БДД приступа
- 10 најбољих алата за тестирање АПИ-ја у 2021. години (СОАП и РЕСТ АПИ алати за тестирање)
- РЕСТ АПИ тестирање помоћу Спринг РестТемплате и ТестНГ
- Како аутоматизовати захтеве за АПИ помоћу „Будите сигурни“ и Јенкинс
- Водич за Парасофт СОАтест: Алат за тестирање АПИ-ја без скрипти