Skip to content

API documentationΒ #57

Description

@whatdoes3plus1equalsto

πŸ—’οΈ Task Description

Summary
We need a good solution for documenting our server API.

Details
Currently, all our API documentation is in a file called server/docs/api.md.

Do some research to find tools or methods of documenting a website API. One such tool is API Fiddle.

This is an open-ended task, but some general requirements for the proposed solution are:

  • Free
  • Easy to edit
  • Permanent (we don't want to lose our documentation if the service pulls a rug)
  • Supports many users

Some nice-to-haves are:

  • Version control
  • Admin privileges
  • Used in industry
  • Database documentation support

We may add to these lists over time.

βœ… Completion Criteria

  • Find one or more solutions that meet the requirements above
  • Write a comment here explaining the solutions and their pros and cons
  • Create an example using one of the solutions, documenting the Payload endpoints

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationserver

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions