طراحی API ها با مشخصات
طراحی API Specification در Postman
آخرین بهروزرسانی: 1405-04-15Spec Hub در Postman برای طراحی API با رویکرد API-first استفاده میشود. در Spec Hub میتوانید specificationهای OpenAPI، AsyncAPI، protobuf، GraphQL و Smithy بسازید یا specificationهای موجود را وارد کنید. ابزارهایی مثل outline view، snippetها، autocomplete، syntax checking و پیشنمایش زنده مستندات به شما کمک میکنند ساختار API را دقیقتر طراحی کنید. فرمتهای پشتیبانیشده Postman...
ساخت API Specification جدید در Postman
آخرین بهروزرسانی: 1405-04-15برای طراحی و تست ساختار API میتوانید در Spec Hub یک specification جدید بسازید. Postman از ساخت specification در فرمتهای OpenAPI، AsyncAPI، protobuf، GraphQL و Smithy پشتیبانی میکند. بعد از ساخت، میتوانید specification را با دیگران به اشتراک بگذارید و روی آن همکاری کنید. ساخت specification جدید در sidebar روی گزینه افزودن کلیک کنید و...
وارد کردن API Specification در Postman
آخرین بهروزرسانی: 1405-04-15اگر از قبل API specification دارید، میتوانید آن را وارد Spec Hub کنید و طراحی، تست و همکاری روی آن را در Postman ادامه دهید. Spec Hub از OpenAPI، AsyncAPI، protobuf، GraphQL و Smithy پشتیبانی میکند. روشهای import کردن specification در sidebar، گزینه Import را انتخاب کنید. یکی از روشهای زیر را برای وارد کردن...
ویرایش API Specification در Postman
آخرین بهروزرسانی: 1405-04-15در Spec Hub میتوانید API specification را ویرایش کنید تا ساختار و طراحی API بهروز شود. Postman برای حرکت داخل specification، اضافه کردن بخشهای جدید، تولید schema از JSON، autocomplete، بررسی خطاهای syntax و پیشنمایش زنده مستندات ابزارهای کاربردی دارد. حرکت داخل specification ساختار API شما در specification تعریف میشود. در sidebar، outline specification نمایش...
مدیریت Multi-file API Specification در Postman
آخرین بهروزرسانی: 1405-04-15در Spec Hub میتوانید API specification را در چند فایل و پوشه نگه دارید. این کار برای APIهای بزرگ مفید است، چون ساختار specification مرتبتر میشود و مدیریت بخشهای مختلف سادهتر خواهد بود. فرمتهای پشتیبانیشده Postman برای multi-file specification از این فرمتها پشتیبانی میکند: OpenAPI ۲.۰، ۳.۰ و ۳.۱ protobuf ۲ و protobuf ۳ Multi-file...
اعتبارسنجی API Specification در Postman
آخرین بهروزرسانی: 1405-04-15هنگام ویرایش API specification، Postman خطاهای syntax و بعضی مشکلهای API governance را تشخیص میدهد و جزئیات آنها را نشان میدهد تا بتوانید سریعتر اصلاحشان کنید. این قابلیت کمک میکند specification قبل از انتشار یا استفاده در collectionها، کیفیت بهتری داشته باشد. Validation pane زیر specification editor، Postman در تب Issues پنل validation را نمایش...
مشاهده Live Documentation برای API Specification
آخرین بهروزرسانی: 1405-04-15وقتی در Postman یک OpenAPI یا AsyncAPI specification را ویرایش میکنید، میتوانید پیشنمایش زنده مستندات API را ببینید. این preview با تغییر specification بهروزرسانی میشود و کمک میکند اثر تغییرات را همان لحظه روی مستندات ببینید. نمایش live preview برای نمایش preview، در sidebar سمت راست روی Live preview کلیک کنید. اگر OpenAPI specification شما...
استفاده دوباره از componentهای specification با Component Library در Postman
آخرین بهروزرسانی: 1405-04-15Component Library در Postman برای تیمهایی است که میخواهند componentهای رایج OpenAPI specification را یک بار تعریف کنند و در چند specification دوباره استفاده کنند. این قابلیت در پلنهای Enterprise ارائه میشود و برای مدیریت متمرکز schemaها، responseها، parameterها و componentهای مشابه در Spec Hub کاربرد دارد. Component Library از AsyncAPI specification پشتیبانی نمیکند. فایل...
همکاری روی specificationها در Postman
آخرین بهروزرسانی: 1405-04-15در Spec Hub میتوانید API specification را همراه تیم طراحی کنید، لینک آن را با همکاران به اشتراک بگذارید، روی بخشهای مختلف comment بگذارید، تغییرات را در changelog ببینید و در صورت نیاز از specification fork بگیرید تا بدون اثر گذاشتن روی نسخه اصلی روی آن کار کنید. اشتراکگذاری specification برای share کردن یک specification،...
ساخت collection از API specification در Postman
آخرین بهروزرسانی: 1405-04-15در Postman میتوانید از روی API specification یک collection بسازید تا اعضای تیم یا مصرفکنندگان API بتوانند endpointها را تست کنند و قابلیتهای API را ببینند. اگر collection از OpenAPI ۲.۰، ۳.۰ یا ۳.۱ ساخته شده باشد، امکان sync بین collection و specification هم وجود دارد. ساخت collection از specification Postman میتواند از specificationهای OpenAPI،...
مرجع همگامسازی collection و specification در Postman
آخرین بهروزرسانی: 1405-04-15این مرجع رفتارهای مهم Postman هنگام تولید specification از collection، تولید collection از specification و sync دوطرفه بین آنها را خلاصه میکند. تمرکز این صفحه روی Spec Hub و تفاوتهای OpenAPI ۲.۰، ۳.۰ و ۳.۱ است. Sync از collection به specification این بخش برای زمانی است که از collection یک API specification میسازید یا تغییرات...
