فرستادن web api

بطور مثال شما یه route دارید برای ساخت مقالات جدید..
خوب شما باید به Consumer یا استفاده کننده این API اطلاعات زیر رو بدید:

• آدرس Endpoint (http://example.com/articles/create)
• پارامترهای ارسالی برای ساخت مقاله جدید (title, body و هر فیلد دیگه که دارید)

اینها موارد ابتدایی هست. که حتما باید در اختیار استفاده کننده قرار بگیره
حالا اگر در جایی دارید یک کد خاص رو برمیگردونی مثلا کد ۶۴۷ ... باید در مستنداتی چیزی اعلام کنید که این کد در اپلیکیشن شما نشانه چی هست