Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Within the General Info section:
    • Name: This is used internally and needs to be unique to this file.
    • Summary: This is a short description of what this API does.
    • HTTP Method: The method type used to access this API - Get (Retrieving information), Delete (Deleting information), Put (Updating information), and Post (everything else)
    • HTTP Path: This is the URL path that will activate this API - examples:
    •     /customers          this would represent a RESTful API to get a list of customers
    •     /customer/:id      this would represent a RESTful API to get a single customer for which its ID column equals this path input parameter
    • Category and Sub Category:  These allow you to categorize API's for easier search and maintenance.
    • Tag: Another way to categorize your APIs.
    • Description:  Describes this API.  This field supports CommonMark. This will help the consumers of this API as well as future maintenance of this API.
    • Use CORS: Check this if you want this API to be accessible to other websites, including other internal web servers.
    • Deprecated: Check this if you want to mark this API as deprecated or soon to be removed.
    • Disabled: Check this if you want to disable this API from being served.
  • In the Output Info section:
    • With most API you will want to describe some sort of output information. This will help the consumers of this API as well as future maintenance of this API.
    • The output parameters are not validated. Their only purpose is to allow you to better document what your The Output Info section allows you to describe the output of your API if it generates output. Describing the output helps consumers of the API and improves future maintenance of the API. Output parameters are not validated; their only purpose is to better document what the API returns.
    • Description: Describes what is being returned by this API.  This field supports CommonMark.
    • Output Parameters: (See additional information in the Input Parameters section below regarding drag-and-drop and creating complex objects)
      • Name: Unique name for this parameter (at this level)
      • Data type: The type of value that will be sent from the API.
      • Is Array: Check if the value is an Array. This is used with the Data Type to better describe a parameter, such as an array of integers.
      • Deprecated: Check this if you want to mark this parameter as deprecated or soon to be removed.
      • Description: Describe the parameter.  This field supports CommonMark.
  • In the Test section
    • You can test your API, seeing all of the parameters along with your API result
  • In the Stats section
    • You can view usage about this API, such as
      • Number of requests
      • Average response time
      • Average payload size

...