زبان سلام
ویرایشگر آنلاین

کتابخانه‌ی استاندارد · شبکه

سواگر net/http/swagger

نوشتن مستندات OpenAPI برای API و نمایش صفحه‌ی مستندات.

واردسازی شبکه.اچ تی تی پی شبکه.سواگر
در این صفحه
  1. گونه‌ها
  2. پایاها و متغیرها
  3. روال‌ها

سواگر مستندات API را در قالب استاندارد OpenAPI می‌سازد و صفحه‌ای برای دیدن و آزمودن آن سرو می‌کند. با مسیر یک عملیات را انتخاب می‌کنید و روال‌های بعدی، مثل خلاصه و برمی گرداند، همان را توصیف می‌کنند.

طرحواره‌ی بدنه‌ها و پاسخ‌ها از یک مقدار نمونه ساخته می‌شود؛ یک ساختار خالی بدهید تا فیلدهایش، با نام‌های @json، در مستندات بیایند. جا افتاده مسیرهایی را نشان می‌دهد که هنوز مستند نشده‌اند.

گونه‌ها

پارامتر Param

ساختار پارامتر
یک پارامتر.
نامانگلیسیگونهتوضیح
namenameرشته = ""نام.
loclocرشته = "query"جا: query، header، cookie یا path.
requiredrequiredمنطقی = نادرستالزامی.
descriptiondescriptionرشته = ""توضیح.
schemaschemaرشته = "{"گونه":"string"}"طرحواره.
net-http-swagger-Build.salam
واردسازی شبکه.اچ تی تی پی شبکه.سواگر
واردسازی کدگذاری.جیسون

ساختار کتاب:
    @json "id"
    همگانی شناسه: صحیح = ۰
    @json "title"
    همگانی عنوان: رشته = ""
پایان

روال ریشه:
    ناپایا س := سواگر.جدید("کتابخانه"، "1.2.0")
    سواگر.توضیح(س، "API نمونه برای کتاب‌ها")
    سواگر.سرور(س، "https://api.example.com"، "اصلی")
    سواگر.تماس(س، "تیم سلام"، "https://salamlang.ir"، "[email protected]")
    سواگر.پروانه(س، "MIT"، "https://opensource.org/licenses/MIT")
    سواگر.احراز هویت حامل(س، "token"، "JWT")
    سواگر.احراز هویت کلید(س، "key"، "header"، "X-API-Key")
    _ := سواگر.مسیر(س، "GET"، "/books/:id")
    سواگر.خلاصه(س، "یک کتاب")
    سواگر.جزئیات(س، "کتاب را با شناسه برمی‌گرداند.")
    سواگر.برچسب(س، "books")
    سواگر.شناسه عملیات(س، "getBook")
    سواگر.پارامتر مسیر(س، "id"، "شناسه‌ی کتاب")
    سواگر.پرسمان(س، "fields"، "فیلدهای خواسته‌شده"، نادرست)
    سواگر.پرسمان نوع دار(س، "limit"، "حداکثر"، نادرست، ۱۰)
    ناپایا ترتیب‌ها := وکتور {} برگردان وکتور<رشته>
    ترتیب‌ها.بیفزا("title")
    ترتیب‌ها.بیفزا("id")
    سواگر.پرسمان گزینه ای(س، "sort"، "ترتیب"، نادرست، ترتیب‌ها)
    سواگر.سرصفحه(س، "X-Trace"، "شناسه‌ی رهگیری"، نادرست)
    سواگر.کوکی(س، "sid"، "نشست"، نادرست)
    سواگر.امن(س، "token")
    سواگر.برمی گرداند(س، ۲۰۰، "کتاب"، کتاب {})
    سواگر.برمی گرداند سرصفحه(س، ۲۰۰، "ETag"، "نسخه")
    سواگر.بدون بدنه برمی گرداند(س، ۴۰۴، "پیدا نشد")
    _ := سواگر.مسیر(س، "POST"، "/books")
    سواگر.می پذیرد(س، "کتاب تازه"، کتاب {})
    سواگر.برمی گرداند(س، ۲۰۱، "ساخته شد"، کتاب {})
    _ := سواگر.مسیر(س، "PUT"، "/books/:id/cover")
    سواگر.می پذیرد خام(س، "تصویر جلد"، "image/png"، "{\"type\":\"string\",\"format\":\"binary\"}"، درست)
    سواگر.برمی گرداند متن(س، ۲۰۰، "انجام شد")
    _ := سواگر.مسیر(س، "POST"، "/books/:id/notes")
    سواگر.می پذیرد اختیاری(س، "یادداشت"، کتاب {})
    سواگر.می پذیرد فرم(س، "فرم"، کتاب {})
    سواگر.برمی گرداند خام(س، ۲۰۰، "خروجی"، "text/csv"، "{\"type\":\"string\"}")
    سواگر.برمی گرداند اچ تی ام ال(س، ۲۰۰، "صفحه")
    سواگر.برمی گرداند پرونده(س، ۲۰۰، "پرونده"، "application/pdf")
    سواگر.منسوخ(س)
    سرچاپ سواگر.انتخاب مسیر(س، "get"، "/books/:id")، سواگر.انتخاب مسیر(س، "GET"، "/nope")
    سرچاپ س.ops.طول()، س.ops[۰].params.طول()، س.ops[۰].replies.طول()، س.ops[۳].is_deprecated، س.schemes.طول()
    متن := سواگر.مشخصات(س)
    سرچاپ جیسون.معتبر(متن)، جیسون.دریافت(متن، "openapi")
    سرچاپ سواگر.مشخصات با تورفتگی(س).طول() > متن.طول()
    سرچاپ سواگر.مشکلات(س).طول()، سواگر.توضیح داده نشده(س)
    سرچاپ سواگر.نوشتن مشخصات(س، "openapi.json")، سواگر.مشخصات از پرونده("openapi.json").طول() > ۰، سواگر.مشخصات از پرونده("نیست.json")
    سرچاپ سواگر.طرحواره متن، سواگر.نوع جیسون
    سواگر.آزاد سازی(س)
پایان
خروجیtrue false 4 6 2 true 2 true 3.1.0 true 0 [] true true {"type":"string"} application/json

پاسخ Reply

ساختار پاسخ
یک پاسخ.
نامانگلیسیگونهتوضیح
codecodeصحیح = 200کد وضعیت.
descriptiondescriptionرشته = ""توضیح.
schemaschemaرشته = ""طرحواره‌ی بدنه.
content_typecontent_typeرشته = "application/json"نوع محتوا.
header_namesheader_namesوکتور<رشته>نام سرآیندهای پاسخ.
header_notesheader_notesوکتور<رشته>توضیح آن‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

طرح احراز هویت Scheme

ساختار طرح احراز هویت
یک روش احراز هویت.
نامانگلیسیگونهتوضیح
namenameرشته = ""نام.
kindkindرشته = "http"نوع: http یا apiKey.
schemeschemeرشته = "bearer"برای http، مثل bearer.
formatformatرشته = ""قالب توکن، مثل JWT.
loclocرشته = "header"جای کلید.
paramparamرشته = ""نام پارامتر کلید.
descriptiondescriptionرشته = ""توضیح.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

عملیات Op

ساختار عملیات
یک عملیات: یک روش روی یک مسیر.
نامانگلیسیگونهتوضیح
methodmethodرشته = ""روش.
patternpatternرشته = ""الگوی مسیر.
op_idop_idرشته = ""شناسه‌ی عملیات.
summarysummaryرشته = ""خلاصه.
descriptiondescriptionرشته = ""توضیح.
is_deprecatedis_deprecatedمنطقی = نادرستمنسوخ است.
tagstagsوکتور<رشته>برچسب‌ها.
paramsparamsوکتور<پارامتر>پارامترها.
repliesrepliesوکتور<پاسخ>پاسخ‌ها.
securitysecurityوکتور<رشته>روش‌های احراز هویت لازم.
body_schemabody_schemaرشته = ""طرحواره‌ی بدنه.
body_descriptionbody_descriptionرشته = ""توضیح بدنه.
body_requiredbody_requiredمنطقی = درستبدنه الزامی است.
body_content_typebody_content_typeرشته = "application/json"نوع محتوای بدنه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

تعریف Definition

ساختار تعریف
تعریف یک گونه در طرحواره.
نامانگلیسیگونهتوضیح
namenameرشته = ""نام.
bodybodyرشته = ""طرحواره‌ی جیسون.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

سند Doc

ساختار سند
سند OpenAPI در حال ساخت.
نامانگلیسیگونهتوضیح
titletitleرشته = "API"عنوان API.
versionversionرشته = "1.0.0"نسخه.
descriptiondescriptionرشته = ""توضیح.
serversserversوکتور<رشته>نشانی سرورها.
server_notesserver_notesوکتور<رشته>توضیح هر سرور.
opsopsوکتور<عملیات>عملیات‌ها.
defsdefsوکتور<تعریف>تعریف گونه‌ها.
schemesschemesوکتور<طرح احراز هویت>روش‌های احراز هویت.
contact_namecontact_nameرشته = ""نام تماس.
contact_urlcontact_urlرشته = ""نشانی تماس.
contact_emailcontact_emailرشته = ""ایمیل تماس.
license_namelicense_nameرشته = ""نام پروانه.
license_urllicense_urlرشته = ""نشانی پروانه.
curcurصحیح = -1شماره‌ی عملیات فعلی؛ روال‌های توصیف روی همین کار می‌کنند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

پایاها و متغیرها

نوع جیسون JSON_TYPE

پایا نوع جیسون: رشته = "application/json"
نوع محتوای جیسون.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

نوع متن TEXT_TYPE

پایا نوع متن: رشته = "text/plain; charset=utf-8"
نوع محتوای متن ساده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

نوع اچ تی ام ال HTML_TYPE

پایا نوع اچ تی ام ال: رشته = "text/html; charset=utf-8"
نوع محتوای HTML.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

نوع فرم FORM_TYPE

پایا نوع فرم: رشته = "application/x-www-form-urlencoded"
نوع محتوای فرم.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

طرحواره متن TEXT_SCHEMA

پایا طرحواره متن: رشته = "{"گونه":"string"}"
طرحواره‌ی رشته.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

طرحواره دودویی BINARY_SCHEMA

پایا طرحواره دودویی: رشته = "{"گونه":"string"،"format":"binary"}"
طرحواره‌ی داده‌ی دودویی، برای پرونده‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

روال‌ها

جدید New

روال جدید(title: رشته، version: رشته): سند
سند تازه با عنوان و نسخه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

توضیح Describe

روال توضیح(d &: سند، text: رشته)
توضیح کلی API.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

سرور Server

روال سرور(d &: سند، url: رشته، note: رشته)
نشانی یک سرور را با توضیح اضافه می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

تماس Contact

روال تماس(d &: سند، name: رشته، url: رشته، email: رشته)
اطلاعات تماس.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

پروانه License

روال پروانه(d &: سند، name: رشته، url: رشته)
پروانه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

احراز هویت حامل BearerAuth

روال احراز هویت حامل(d &: سند، name: رشته، format: رشته)
احراز هویت با توکن Bearer تعریف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

احراز هویت کلید ApiKeyAuth

روال احراز هویت کلید(d &: سند، name: رشته، loc: رشته، param: رشته)
احراز هویت با کلید API در سرآیند، پرس‌وجو یا کوکی تعریف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

مسیر Route

روال مسیر(d &: سند، method: رشته، pattern: رشته): صحیح
عملیاتی را برای روش و مسیر اضافه می‌کند، یا اگر هست انتخاب می‌کند، و شماره‌اش را برمی‌گرداند. پارامترهای :name مسیر خودکار ثبت می‌شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

انتخاب مسیر At

روال انتخاب مسیر(d &: سند، method: رشته، pattern: رشته): منطقی
عملیات موجود را انتخاب می‌کند؛ اگر نباشد، نادرست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

خلاصه Summary

روال خلاصه(d &: سند، text: رشته)
خلاصه‌ی عملیات فعلی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

جزئیات Details

روال جزئیات(d &: سند، text: رشته)
توضیح کامل.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برچسب Tag

روال برچسب(d &: سند، name: رشته)
برچسبی برای گروه‌بندی در صفحه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

شناسه عملیات OperationId

روال شناسه عملیات(d &: سند، id: رشته)
شناسه‌ی یکتای عملیات، برای ابزارهای تولید کد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

منسوخ Deprecated

روال منسوخ(d &: سند)
عملیات را منسوخ علامت می‌زند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

امن Secure

روال امن(d &: سند، scheme: رشته)
احراز هویت تعریف‌شده را برای عملیات لازم می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

پرسمان Query

روال پرسمان(d &: سند، name: رشته، description: رشته، required: منطقی)
پارامتر پرس‌وجوی رشته‌ای.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

پرسمان نوع دار QueryTyped

روال پرسمان نوع دار<T>(d &: سند، name: رشته، description: رشته، required: منطقی، sample: T)
پارامتر پرس‌وجو با گونه‌ای که از مقدار نمونه برداشته می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

پرسمان گزینه ای QueryEnum

روال پرسمان گزینه ای(d &: سند، name: رشته، description: رشته، required: منطقی، values: وکتور<رشته>)
پارامتر پرس‌وجو با مقدارهای مجاز.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

روال سرصفحه(d &: سند، name: رشته، description: رشته، required: منطقی)
پارامتر سرآیند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

روال کوکی(d &: سند، name: رشته، description: رشته، required: منطقی)
پارامتر کوکی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

پارامتر مسیر PathParam

روال پارامتر مسیر(d &: سند، name: رشته، description: رشته)
توضیح یک پارامتر مسیر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

می پذیرد Accepts

روال می پذیرد<T>(d &: سند، description: رشته، sample: T)
بدنه‌ی جیسون با طرحواره‌ی گونه‌ی نمونه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

می پذیرد اختیاری AcceptsOptional

روال می پذیرد اختیاری<T>(d &: سند، description: رشته، sample: T)
مثل روال بالا، ولی بدنه اختیاری است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

می پذیرد خام AcceptsRaw

روال می پذیرد خام(d &: سند، description: رشته، content_type: رشته، schema: رشته، required: منطقی)
بدنه با نوع محتوا و طرحواره‌ای که خودتان می‌دهید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

می پذیرد فرم AcceptsForm

روال می پذیرد فرم<T>(d &: سند، description: رشته، sample: T)
بدنه‌ی فرم با فیلدهای گونه‌ی نمونه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برمی گرداند Returns

روال برمی گرداند<T>(d &: سند، code: صحیح، description: رشته، sample: T)
پاسخ جیسون با کد و طرحواره‌ی گونه‌ی نمونه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برمی گرداند خام ReturnsRaw

روال برمی گرداند خام(d &: سند، code: صحیح، description: رشته، content_type: رشته، schema: رشته)
پاسخ با نوع محتوا و طرحواره‌ی دلخواه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برمی گرداند متن ReturnsText

روال برمی گرداند متن(d &: سند، code: صحیح، description: رشته)
پاسخ متنی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برمی گرداند اچ تی ام ال ReturnsHtml

روال برمی گرداند اچ تی ام ال(d &: سند، code: صحیح، description: رشته)
پاسخ HTML.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برمی گرداند پرونده ReturnsFile

روال برمی گرداند پرونده(d &: سند، code: صحیح، description: رشته، content_type: رشته)
پاسخ پرونده با نوع محتوا.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

برمی گرداند سرصفحه ReturnsHeader

روال برمی گرداند سرصفحه(d &: سند، code: صحیح، name: رشته، description: رشته)
سرآیندی را به پاسخ با این کد اضافه می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

بدون بدنه برمی گرداند ReturnsNothing

روال بدون بدنه برمی گرداند(d &: سند، code: صحیح، description: رشته)
پاسخ بدون بدنه، مثل ۲۰۴ یا ۴۰۴.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

مشخصات Spec

روال مشخصات(d: سند): رشته
سند را به جیسون OpenAPI 3.1 تبدیل می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

مشخصات با تورفتگی SpecIndent

روال مشخصات با تورفتگی(d: سند): رشته
مثل روال بالا، خوانا با تورفتگی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

نصب Mount

روال نصب(d: سند، r &: router.Router، prefix: رشته)
صفحه‌ی مستندات و openapi.json را زیر پیشوند داده‌شده به مسیریاب اضافه می‌کند.
net-http-swagger-Serve.salam
واردسازی شبکه.اچ تی تی پی شبکه
واردسازی شبکه.اچ تی تی پی شبکه.سواگر
واردسازی شبکه.مسیریاب شبکه
واردسازی رشته

روال فهرست(ز: صحیح۶۴):
    اچ تی تی پی شبکه.جیسون زمینه(ز، "[]")
پایان

روال ریشه:
    ناپایا م := مسیریاب شبکه.مسیریاب جدید()
    مسیریاب شبکه.دریافت(م، "/books"، فهرست)
    مسیریاب شبکه.ارسال(م، "/books"، فهرست)
    مسیریاب شبکه.دریافت(م، "/admin/stats"، فهرست)
    ناپایا س := سواگر.جدید("کتابخانه"، "1.0.0")
    سرچاپ سواگر.جا افتاده(س، م)
    سواگر.پویش با پیشوند(س، م، "/books")
    سرچاپ س.ops.طول()، سواگر.جا افتاده(س، م)
    سواگر.پویش(س، م)
    سرچاپ س.ops.طول()، سواگر.جا افتاده(س، م).طول()
    سواگر.نصب(س، م، "/docs")
    ناپایا سرور := اچ تی تی پی شبکه.سرور جدید(۱۹۶۰۷)
    اچ تی تی پی شبکه.استفاده(سرور، م)
    _ := اچ تی تی پی شبکه.اجرا در پس زمینه(سرور)
    پ := اچ تی تی پی شبکه.دریافت("http://127.0.0.1:19607/docs/openapi.json")
    سرچاپ اچ تی تی پی شبکه.وضعیت(پ)، رشته.شامل است(اچ تی تی پی شبکه.بدنه(پ)، "/admin/stats")
    صفحه := اچ تی تی پی شبکه.دریافت("http://127.0.0.1:19607/docs")
    سرچاپ رشته.شامل است(اچ تی تی پی شبکه.بدنه(صفحه)، "<html")
    ناپایا م۲ := مسیریاب شبکه.مسیریاب جدید()
    سواگر.نصب مشخصات("{\"openapi\":\"3.1.0\"}"، "آماده"، م۲، "/spec")
    سرچاپ م۲.routes.طول()
    سرچاپ سواگر.سرو(س، ۱۹۶۰۸)، اچ تی تی پی شبکه.وضعیت(اچ تی تی پی شبکه.دریافت("http://127.0.0.1:19608/openapi.json"))
    سرچاپ سواگر.سرو مشخصات("{\"openapi\":\"3.1.0\"}"، "دیگر"، ۱۹۶۰۹)
    سرچاپ رشته.شامل است(سواگر.صفحه("API"، "/openapi.json")، "/openapi.json")
پایان
خروجی["GET /books", "POST /books", "GET /admin/stats"] 2 ["GET /admin/stats"] 3 0 200 true true 3 true 200 true true

نصب مشخصات MountSpec

روال نصب مشخصات(spec: رشته، title: رشته، r &: router.Router، prefix: رشته)
مثل روال بالا، با مشخصات آماده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam

سرو Serve

روال سرو(d: سند، port: صحیح): منطقی
صفحه‌ی مستندات را روی درگاه جدا در پس‌زمینه اجرا می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam

سرو مشخصات ServeSpec

روال سرو مشخصات(spec: رشته، title: رشته، port: صحیح): منطقی
مثل روال بالا، با مشخصات آماده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam

مشخصات از پرونده SpecFromFile

روال مشخصات از پرونده(path: رشته): رشته
مشخصات آماده را از پرونده می‌خواند؛ اگر نباشد، رشته‌ی خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

نوشتن مشخصات WriteSpec

روال نوشتن مشخصات(d: سند، path: رشته): منطقی
سند را در پرونده می‌نویسد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

مشکلات Problems

روال مشکلات(d: سند): وکتور<رشته>
ایرادهای سند: عنوان یا نسخه‌ی خالی، شناسه‌ی تکراری و مانند آن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

توضیح داده نشده Undocumented

روال توضیح داده نشده(d: سند): وکتور<رشته>
عملیات‌هایی که خلاصه، توضیح و پاسخ ندارند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

جا افتاده Missing

روال جا افتاده(d: سند، r: router.Router): وکتور<رشته>
مسیرهایی از مسیریاب که در سند نیستند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam

آزاد سازی Free

روال آزاد سازی(d &: سند)
حافظه‌ی سند را آزاد می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Build.salam

صفحه Page

روال صفحه(title: رشته، spec_url: رشته): رشته
متن HTML صفحه‌ی مستندات که مشخصات را از نشانی داده‌شده می‌خواند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam

پویش Scan

روال پویش(d &: سند، r: router.Router)
برای همه‌ی مسیرهای مسیریاب عملیات می‌سازد تا بعد توصیفشان کنید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam

پویش با پیشوند ScanPrefix

روال پویش با پیشوند(d &: سند، r: router.Router، prefix: رشته)
مثل روال بالا، فقط برای مسیرهای با این پیشوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: net-http-swagger-Serve.salam