Ikiwa bado hutumii lugha ya ufafanuzi kwa vipimo vya API inayoweza kusomeka na mashine, kama vile OpenAPI (zamani ikijulikana kama Swagger), bila shaka unapaswa kuzingatia kufanya hivyo. Baada ya yote, API ni lugha za mashine kuzungumza nazo.
Je, Swagger ni wazo zuri?
Swagger hutoa mwonekano mzuri sana wa kwanza Mbali na hilo, watu wengi wanafikiri kuwa uwezekano wa kutoa msimbo kutoka kwa uhifadhi ni wazo zuri na Swagger hutoa hilo. vilevile. Kwa hivyo ukweli kwamba swagger hufanya mwonekano mzuri wa kwanza, hufanya mapungufu na vizuizi vyake kutoonekana.
Kusudi la kutumia Swagger ni nini?
Swagger hukuruhusu kuelezea muundo wa API zako ili mashine ziweze kuzisoma. Uwezo wa API kuelezea muundo wao wenyewe ndio mzizi wa uzuri wote katika Swagger.
Je, Swagger bado inatumika?
Leo, watumiaji wengi bado wanatumia maneno " Swagger" kurejelea umbizo la Uainisho la OpenAPI 2.0, na "Swagger spec" kurejelea hati ya maelezo ya API katika umbizo hili.. RepreZen API Studio hutumia maneno haya katika baadhi ya sehemu za UI, lakini inarejelea OpenAPI 3.0 na matoleo ya baadaye kama "OpenAPI. "
Je swagger ni kwa REST API pekee?
Viainisho vya OpenAPI (hapo awali viliitwa Swagger Specification) ni umbizo la maelezo ya API kwa API za REST. Faili ya OpenAPI hukuruhusu kuelezea API yako yote, ikijumuisha: Miisho inayopatikana (/watumiaji) na uendeshaji kwenye kila sehemu ya mwisho (GET /users, POST /users)
