https://github.com/app-generator/api-server-unified

Unified API Definition - API Servers | AppSeed
https://github.com/app-generator/api-server-unified

api appseed definition

Last synced: about 1 month ago
JSON representation

Unified API Definition - API Servers | AppSeed

• Host: GitHub
• URL: https://github.com/app-generator/api-server-unified
• Owner: app-generator
• License: other
• Created: 2021-07-24T08:15:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-24T14:43:09.000Z (over 3 years ago)
• Last Synced: 2024-10-11T04:43:31.055Z (2 months ago)
• Topics: api, appseed, definition
• Homepage: https://docs.appseed.us/boilerplate-code/api-unified-definition
• Size: 8.79 KB
• Stars: 3
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - app-generator/api-server-unified - Unified API Definition - API Servers | AppSeed (Others)

README

        
# API Server Unified 

This document describes the **[unified defintion](https://docs.appseed.us/boilerplate-code/api-unified-definition)** used by all API servers provided by AppSeed. This internal standard is used by all full-stack products, despite the UI or backend technology. 




> API Servers aligned to use it: 

- [API Server Django](https://github.com/app-generator/api-server-django) - free product

- [API Server Flask](https://github.com/app-generator/api-server-flask) - free product

- [API Server FastAPI](#) - free product / **Work in progress**

- [API Server Node JS](https://github.com/app-generator/api-server-nodejs) - free product

- [API Server Node JS PRO](https://github.com/app-generator/api-server-nodejs) - commercial product

 

 


> UI Products aligned to use it:

- [React Berry Dashboard](https://appseed.us/product/react-node-js-berry-dashboard) - free product

- [React Datta Able](https://github.com/app-generator/react-datta-able-dashboard) - free product

- [React Datta Able PRO](https://appseed.us/product/react-node-js-datta-able-pro) - commercial product




> For more information or support please access the [AppSeed](https://appseed.us/) platform or chat directly with support team on [Discord](https://appseed.us/support).




## API Information

> Interface descriptor - [POSTMAN collection format](https://github.com/app-generator/api-unified-definition/blob/main/api.postman_collection.json)

- USERS API: 

  - `/api/users/register`: create a new user

  - `/api/users/login`: authenticate an existing user

  - `/api/users/logout`: delete the associated JWT token 

  - `/api/users/checkSession`: check an existing JWT Token for validity

  - `/api/users/edit` - edit the information associated with a registered user




---

[API Server Unified](https://docs.appseed.us/boilerplate-code/api-unified-definition) - Internal API Interface definition used by AppSeed [App Generator](https://appseed.us)