Skip to content

Instantly share code, notes, and snippets.

@cobalt88

cobalt88/Route-Map-Template.md

Last active June 23, 2022 01:51
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save cobalt88/b8ac2501c08e6ae5bf3d13e01735c7c6 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save cobalt88/b8ac2501c08e6ae5bf3d13e01735c7c6 to your computer and use it in GitHub Desktop.
Download ZIP
Documentation Templates
Raw
Route-Map-Template.md

API Route Map

This document details all the complete and tested routes available in the controllers folder, how to access them, what data they expect to receive in the requests sent to them, and what data you should expect in the response from that route.

Contents

Route Group 1

Note: It is recommended to group your routes by functionality, both in your file structure and in your documentation. For example if you have a users directory and an admin directory, and each of those directories has their own sub directories, write out the documentation in the same layout. This way the flow of your documentation matches the flow of your system architecture, making it a lot easier to read.

  • GET Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: GET
    URL: ""
    Example: ""

  • POST Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: POST
    URL: ""
    Example: ""

  • PUT Route Map Template:
    Request Requirements:
    Expected Response: ""
    Method: PUT
    URL: ""
    Example: ""

  • DELETE Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: DELETE
    URL: ""
    Example: ""

Route Group 2

  • GET Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: GET
    URL: ""
    Example: ""

  • POST Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: POST
    URL: ""
    Example: ""

  • PUT Route Map Template:
    Request Requirements:
    Expected Response: ""
    Method: PUT
    URL: ""
    Example: ""

  • DELETE Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: DELETE
    URL: ""
    Example: ""

Route Group 3

  • GET Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: GET
    URL: ""
    Example: ""

  • POST Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: POST
    URL: ""
    Example: ""

  • PUT Route Map Template:
    Request Requirements:
    Expected Response: ""
    Method: PUT
    URL: ""
    Example: ""

  • DELETE Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: DELETE
    URL: ""
    Example: ""

Route Group 4

  • GET Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: GET
    URL: ""
    Example: ""

  • POST Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: POST
    URL: ""
    Example: ""

  • PUT Route Map Template:
    Request Requirements:
    Expected Response: ""
    Method: PUT
    URL: ""
    Example: ""

  • DELETE Route Map Template:
    Request Requirements: ""
    Expected Response: ""
    Method: DELETE
    URL: ""
    Example: ""

Models Information

Server Information

About The Author

Author: Vincent Teune
GitHub: https://github.com/cobalt88
Email: [email protected]
Last Updated: June 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment