Minds Docs

Minds Docs

  • Docs
  • Code
  • Minds.com

›Walk-throughs

Getting started

  • Introduction
  • Installation
  • Troubleshooting

Guides

  • Architecture
  • Frontend
  • Backend
  • Mobile
  • Deployment
  • Documentation
  • Git / GitLab

Contributing

  • Contributing
  • License

Walk-throughs

  • Backend modules
  • Backend tests
  • Block
  • Frontend tests
  • Sending emails
  • Feature flags
  • Feed algorithms
  • Infinite scroll
  • Notifications
  • Postman collection
  • Mobile Internationalization
  • Mobile git workflow and CI

Handbook

  • How we work
  • Bug reporting
  • Superhero

Pro

  • Domains
  • Developers
Edit

Postman collection

Getting set up

Firstly, you need to download Postman, and log in with your account.

Enviroment preparation

We use a few enviromental variables to allow us to share endpoints. These can be specified by heading over to the settings cog in the right of postman, and then hitting add. The variables you need and instructions on how to obtain them can be found here:

Postman environmental variables

Collection

Our directory structure is as follows:

API

/
└───api
│   └───v1
|   |   └───...
│   └───v2
|   |   └───...
└───fs
|   └───...

If we want to add a GET request to /api/v2/media/proxy, it belongs in the a corresponding media folder in the v2 directory, named 'api v2 media proxy'.

Standards

  • Naming structure, take the forward slashes out of the endpoint name.
  • Don't make your endpoints dependant on host, use {{ host }}.
  • Try to document your endpoints.
Last updated on 2020-4-9
← NotificationsMobile Internationalization →
Minds Docs
Docs
Getting startedGuidesContributing
Community
Open Source Community GroupStack Overflow
More
GitLabStar
Copyright © 2021 Minds Inc.