Weconnect Api Documentation

in #utopian-io7 years ago (edited)

WeConnect provides a platform that brings businesses and individuals together. This platform creates awareness for businesses and gives the users the ability to write reviews about the businesses they have interacted with.

There was no documentation for Weconnect API before now, It was decided to write an Official API for the application,
The Documentation was developed with Swagger
Heroku Link: https://weconnect-business.herokuapp.com/api-docs/#/

Snapshot:
Screen Shot 2018-03-12 at 10.49.01 PM.png

Screen Shot 2018-03-12 at 10.51.59 PM.png

With the documentation, the routes can now be tested.

The documentation explains the routes with examples of the kind of data that is accepted.

Also, the documentation helps contributors/users to be able to know more about the application before using it.

You can contact me on discord @rhotimee



Posted on Utopian.io - Rewarding Open Source Contributors

Sort:  

Weconnect, great idea. Thumbs up

Your contribution cannot be approved because it is not as informative as other contributions. See the Utopian Rules. Contributions need to be informative and descriptive in order to help readers and developers understand them.

Hi @rhotimee, I've tried your generated swagger UI , but no 'api call' was successful.
Among the only examples that were send to the server and got back was the /auth/signup which replied with:
{ "message": "Input all necessary fields", "error": true } although I completed both email and password.

Most calls returned:
500 Undocumented Error: Internal Server Error

You can contact us on Discord.
[utopian-moderator]

There was an issue with Postgres, I just fixed it.

Thank you for the contribution. It has been approved.

You can contact us on Discord.
[utopian-moderator]

Coin Marketplace

STEEM 0.24
TRX 0.25
JST 0.039
BTC 96247.25
ETH 3349.36
USDT 1.00
SBD 3.28