Gabatar da InterSystems API Manager (+ webinar)

Kwanan nan mun saki Manajan API na InterSystems (IAM), sabon ɓangaren InterSystems IRIS Data Platform wanda ke ba da ganuwa, sarrafawa, da sarrafa zirga-zirgar API na yanar gizo a duk faɗin kayan aikin IT.

A cikin wannan labarin, zan nuna muku yadda ake saita IAM kuma in nuna wasu iyakoki da yawa waɗanda suke da ku tare da IAM. InterSystems API Manager yana ba ku damar:

  • Kula da API, fahimtar wanda ke amfani da API, waɗanne APIs suka fi shahara, kuma waɗanne ne ke buƙatar haɓakawa.
  • Sarrafa wanda ke amfani da API kuma ya iyakance amfani da API daga ƙayyadaddun samun dama ga ƙuntatawa na tushen buƙata - kuna da iko na al'ada kuma kuna iya ba da amsa da sauri ga canza tsarin cin API.
  • Amintattun APIs ta amfani da hanyoyin tsaro na tsakiya kamar OAuth2.0, LDAP ko Tabbatar da Token Maɓalli.
  • Sauƙaƙewa ga masu haɓaka ɓangare na uku kuma samar musu da ingantaccen ƙwarewar API ta buɗe hanyar buɗe hanyar haɓakawa.
  • Yi sikelin API kuma tabbatar da ƙarancin jinkirin amsawa.

Gudanar da API yana da mahimmanci don canzawa zuwa SOA ko gine-ginen microservice, sauƙaƙe haɗin kai tsakanin sabis na mutum (micro), yana sa su samuwa ga duk masu amfani na waje da na ciki. Sakamakon haka, sabbin APIs sun zama masu sauƙi don ƙirƙira, kulawa, da cinyewa.

Idan kuna amfani da InterSystems IRIS, zaku iya ƙara zaɓin IAM zuwa lasisinku. Zaɓin IAM kyauta ne ga abokan cinikin InterSystems IRIS, amma dole ne ku nemi sabon maɓallin lasisi daga InterSystems don fara amfani da IAM.

Idan har yanzu ba ku yi amfani da InterSystems IRIS ba kuma kuna shirin gwada Manajan API na InterSystems, tuntuɓi InterSystems.

Farawa da Shigarwa

Abokan ciniki na InterSystems na iya zazzage rarrabawar IAM daga gidan yanar gizon WRC sashe "Rarraba Software" kuma gudanar azaman akwati Docker. Mafi ƙarancin buƙatun tsarin:

Da farko, kuna buƙatar zazzage hoton Docker (Mahimmanci! Rumbun da ke tare da WRC ba hoton Docker ba ne, kuna buƙatar buɗe shi, akwai hoton Docker a ciki):

docker load -i iam_image.tar

Wannan umarnin zai sa hoton IAM ya kasance don amfani daga baya akan sabar ku. IAM tana gudana azaman akwati daban, don haka zaku iya sike shi da kansa daga InterSystems IRIS. Gudun IAM yana buƙatar samun dama ga InterSystems IRIS don zazzage lasisi.

Saita InterSystems IRIS:

  • Kunna aikace-aikacen gidan yanar gizo /api/IAM
  • Kunna mai amfani IAM
  • Canja kalmar sirri ta mai amfani IAM

Yanzu bari mu fara kwandon IAM. A cikin tarihin za ku sami rubutun iam-setup don Windows da Unix (da Mac). Waɗannan rubutun za su taimaka muku saita masu canjin yanayi daidai, ba da damar akwati na IAM don kafa haɗi tare da InterSystems IRIS. Ga misalin rubutun da ke gudana akan Mac:

source ./iam-setup.sh 
Welcome to the InterSystems IRIS and InterSystems API Manager (IAM) setup script.
This script sets the ISC_IRIS_URL environment variable that is used by the IAM container to get the IAM license key from InterSystems IRIS.
Enter the full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1
Enter the IP address for your InterSystems IRIS instance. The IP address has to be accessible from within the IAM container, therefore, do not use "localhost" or "127.0.0.1" if IRIS is running on your local machine. Instead use the public IP address of your local machine. If IRIS is running in a container, use the public IP address of the host environment, not the IP address of the IRIS container. xxx.xxx.xxx.xxx               
Enter the web server port for your InterSystems IRIS instance: 52773
Enter the password for the IAM user for your InterSystems IRIS instance: 
Re-enter your password: 
Your inputs are:
Full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1
IP address for your InterSystems IRIS instance: xxx.xxx.xxx.xxx
Web server port for your InterSystems IRIS instance: 52773
Would you like to continue with these inputs (y/n)? y
Getting IAM license using your inputs...
Successfully got IAM license!
The ISC_IRIS_URL environment variable was set to: http://IAM:****************@xxx.xxx.xxx.xxx:52773/api/iam/license
WARNING: The environment variable is set for this shell only!
To start the services, run the following command in the top level directory: docker-compose up -d
To stop the services, run the following command in the top level directory: docker-compose down
URL for the IAM Manager portal: http://localhost:8002

Kamar yadda kuke gani, cikakken sunan hoton, adireshin IP, tashar InterSystems IRIS da kalmar sirri don mai amfani da IAM shine kawai kuke buƙatar farawa.

Maimakon gudanar da rubutun, zaku iya saita masu canjin yanayi da hannu:

ISC_IAM_IMAGE=intersystems/iam:0.34-1-1
ISC_IRIS_URL=http://IAM:<PASS>@<IP>:<PORT>/api/iam/license

Kaddamarwa

Yanzu bari mu ƙaddamar da IAM ta hanyar gudanar da umarni:

docker-compose up -d

Wannan umarnin yana tsara kwantena na IAM kuma yana tabbatar da cewa komai yana gudana daidai. Ana duba matsayin kwantena ta amfani da umarnin:

docker ps

Bude dubawar gudanarwa a cikin burauzar ku localhost:8002.

Gabatar da InterSystems API Manager (+ webinar)

Babu komai a yanzu saboda sabon kulli ne. Mu canza wannan. IAM tana goyan bayan manufar wuraren aiki don rarraba APIs zuwa kayayyaki da/ko umarni. Jeka wurin "default" wurin aiki wanda za mu yi amfani da shi don gwaje-gwajenmu.

Gabatar da InterSystems API Manager (+ webinar)

Adadin buƙatun wannan wurin aiki har yanzu ba shi da daraja, amma zaku sami ra'ayi na ainihin dabarun IAM a cikin menu na hagu. Abubuwa biyu na farko: Sabis da Hanyoyi sune mafi mahimmanci:

  • Sabis shine API wanda muke son samar da dama ga masu amfani. Don haka, API ɗin REST a cikin InterSystems IRIS Sabis ne, kamar yadda yake, misali, Google API idan kuna son amfani da shi.
  • Hanyar tana yanke shawarar wacce buƙatun shigowa Sabis ya kamata a tura. Kowace Hanya tana da ƙayyadaddun ƙayyadaddun sharuɗɗa, kuma idan an cika su, ana aika buƙatar zuwa Sabis mai dacewa. Misali, Hanya na iya dacewa da IP, yankin mai aikawa, hanyoyin HTTP, sassan URI, ko haɗin waɗannan misalan.

sabis

Bari mu ƙirƙiri Sabis na IRIS InterSystems, tare da dabi'u masu zuwa:

filin
Ma'ana
Description

sunan
Iris
Sunan sabis

rundunar
IP
InterSystems IRIS uwar garken uwar garken ko ip

tashar jiragen ruwa
52773
InterSystems IRIS tashar yanar gizo uwar garken

hanya
/api/atelier
Tushen hanya

Yarjejeniya
http
ПротокоР»

Bar ragowar ƙimar azaman tsoho. Danna maɓallin Create kuma rubuta ID na Sabis ɗin da aka ƙirƙira.

Hanyar

Yanzu bari mu ƙirƙiri hanya:

filin
Ma'ana
Description

hanya
/api/atelier
Tushen hanya

Yarjejeniya
http
ПротокоР»

sabis.id
jagora daga 3
Sabis (ID daga mataki na baya)

Bar ragowar ƙimar azaman tsoho. Danna maɓallin Create kuma rubuta ID na Hanyar da aka ƙirƙira. Ta hanyar tsoho, IAM tana sauraron buƙatun masu shigowa akan tashar jiragen ruwa 8000. Yanzu an aika buƙatun zuwa http://localhost:8000 kuma farawa da /api/atelier Ana tura su zuwa InterSystems IRIS.

Gwaji

Bari mu gwada ƙirƙirar buƙata a cikin abokin ciniki na REST (Ina amfani da Wasikun Postman).

Gabatar da InterSystems API Manager (+ webinar)

Mu aika da bukatar GET zuwa ga http://localhost:8000/api/atelier/ (kar ka manta / a karshen) kuma sami amsa daga InterSystems IRIS. Kowace buƙatu tana wucewa ta IAM wanda ke tattara ma'auni:

  • Lambar matsayin HTTP.
  • Jinkiri.
  • Kulawa (idan an saita).

Na yi ƴan ƙarin buƙatun (ciki har da buƙatun biyu zuwa wuraren ƙarshen da ba su wanzu kamar /api/atelier/est/), ana iya ganin sakamakon nan da nan a cikin dashboard:

Gabatar da InterSystems API Manager (+ webinar)

Aiki tare da plugins

Yanzu da muna da hanyar da aka saita, za mu iya sarrafa API ɗin mu. Za mu iya ƙara fasalulluka waɗanda za su dace da sabis ɗinmu.

Hanyar da ta fi dacewa don canza halayen API ita ce ƙara plugin. Plugins ke ware ayyukan mutum ɗaya kuma ana iya haɗa su zuwa IAM ko dai a duniya ko zuwa ga ƙungiyoyi ɗaya kawai, kamar Mai amfani (ƙungiyar masu amfani), Sabis ko Hanya. Za mu fara da ƙara plugin ɗin Ƙididdigar Rate zuwa Hanya. Don kafa haɗi tsakanin plugin ɗin da hanya, muna buƙatar mai ganowa na musamman (ID) na hanya.

Iyakance yawan buƙatun

Danna Plugins a menu na gefen hagu. Kuna iya ganin duk abubuwan plugins masu aiki akan wannan allon, amma tunda wannan uwar garken IAM sabuwa ce, babu wasu plugins masu aiki tukuna. Don haka ci gaba zuwa mataki na gaba ta danna "Sabon Plugin".

Plugin da muke buƙata yana cikin rukunin “Ikon Traffic” kuma ana kiransa “Limiting Rate”. Zaɓi shi. Akwai fewan saitunan da zaku iya saitawa anan, amma muna kula da fage biyu kawai:

filin
Ma'ana
Description

hanyar_id
ID
ID na hanya

config.minti
5
Yawan buƙatun a minti daya

Shi ke nan. An saita plugin ɗin kuma yana aiki. Lura cewa za mu iya zaɓar tazarar lokaci daban-daban, kamar minti ɗaya, sa'a ɗaya ko rana ɗaya. Ana iya haɗa saitunan (misali, buƙatun 1000 a kowace awa kuma a lokaci guda buƙatun 100 a cikin minti ɗaya). Na zaɓi mintuna saboda yana sauƙaƙa duba ayyukan plugin ɗin.

Idan kuka sake aika buƙatun iri ɗaya a cikin Postman, za ku ga cewa an dawo da martani tare da ƙarin kanun labarai guda 2:

  • Iyakar XRate-Miti: 5
  • XRateLimit-Sauran-minti: 4

Wannan yana gaya wa abokin ciniki cewa zai iya yin buƙatun har 5 a cikin minti ɗaya kuma yana iya yin ƙarin buƙatun 4 a cikin ramin lokaci na yanzu.

Gabatar da InterSystems API Manager (+ webinar)

Idan kuka yi buƙatu iri ɗaya akai-akai, a ƙarshe za ku ƙare da wadataccen keɓaɓɓen keɓaɓɓen kuma a maimakon haka sami lambar matsayin HTTP na 429 tare da ƙungiyar amsa mai zuwa:

Gabatar da InterSystems API Manager (+ webinar)

Jira minti daya kuma zaku iya sake gabatar da buƙatun.

Wannan tsari ne mai dacewa wanda ke ba ku damar:

  • Kare bayan baya daga hawan kaya.
  • Faɗa wa abokan ciniki yawan buƙatun da za su iya yi.
  • Yi kudi ga API.

Kuna iya saita ƙima don tazara na lokaci daban-daban don haka sauƙaƙe zirga-zirgar API na wani ɗan lokaci. Bari mu ce kuna ba da izinin buƙatun 600 a kowace awa akan wata hanya ta musamman. A matsakaita akwai buƙatun 10 a cikin minti ɗaya. Amma babu abin da zai hana abokin ciniki kammala duk buƙatun 600 a cikin minti na farko na sa'a. Wataƙila wannan shine abin da kuke buƙata. Kuna iya son cimma madaidaicin kaya a cikin sa'a guda. Ta saita ƙimar filin config.minute Ƙimar 20 tana tabbatar da cewa masu amfani da ku ba su wuce buƙatun 20 a minti ɗaya da buƙatun 600 a kowace awa ba. Wannan yana ba da damar ƙananan spikes akan tazara na minti ɗaya idan aka kwatanta da cikakken matsakaiciyar buƙatun 10 a cikin minti ɗaya, amma masu amfani ba za su iya amfani da adadin sa'o'i na minti ɗaya ba. Yanzu za su buƙaci aƙalla mintuna 30 don amfani da duk buƙatun su. Abokan ciniki za su karɓi ƙarin kanun labarai na kowane tazarar lokaci, misali:

HTTP Header
Ma'ana

Iyakar X-Rate-Iyakar-awa
600

Iyakar X-Rate-Sauran Sa'a
595

Iyakar X-Rate-Limit-minti
20

Iyakar X-Rate-Sauran-minti
16

Tabbas, akwai hanyoyi daban-daban don daidaita iyakokin tambaya dangane da abin da kuke son cimmawa.

binciken

Zan gama anan, Ina tsammanin akwai isasshen abu don labarin farko game da InterSystems API Manager. Mun yi amfani da ɗaya daga cikin fiye da 40 plugins. Akwai abubuwa da yawa masu ban sha'awa da za ku iya yi tare da IAM:

  • Ƙara tsarin tantancewa na tsakiya don duk API ɗin ku.
  • Ƙimar nauyin nauyi ta amfani da ma'aunin nauyi a cikin Sabis masu yawa.
  • Ƙara sabbin ayyuka da gyaran kwaro zuwa masu sauraron gwaji kafin cikakken ɗaukaka.
  • Bayar da masu haɓaka ciki da na waje tare da keɓaɓɓen tashar yanar gizo da ke tattara duk APIs.
  • Buƙatun cache don rage lokacin amsawa da rage nauyi akan tsarin baya.

nassoshi

Webinar

Muna gayyatar ku zuwa gidan yanar gizon "Gudanar da API tare da InterSystems API Management", wanda zai faru a ranar Nuwamba 21 a 10: 00 Moscow lokacin (GMT + 3).
InterSystems API Manager (IAM) wani sabon bangare ne na InterSystems IRIS Data Platform wanda ke ba da kulawa, sarrafawa da sarrafa zirga-zirga zuwa / daga APIs na yanar gizo a cikin kayan aikin IT. A webinar za mu nuna maɓalli na iyawar InterSystems API Management:

  • API kayan aikin sa ido kan zirga-zirga.
  • Gudanar da zirga-zirgar ababen hawa na API, gami da sarrafa bandwidth, iyakance adadin kiran API, kiyaye lissafin izini da lissafin adiresoshin IP da aka ƙi, da sauransu.
  • Kayan aikin daidaitawar tsaro na API.
  • Portal mai haɓakawa don buga takaddun API na mu'amala.
  • Wuri ɗaya na samun dama ga API.

An yi nufin webinar don masu gine-gine, masu haɓakawa da masu gudanar da tsarin.

Ana buƙatar rajista!

source: www.habr.com

Add a comment