Home

Black Mage API Docs, guides and reference for the Black Mage API

English

API Level

It presents the specificities related to the pre-processing, processing, storage and CRUD of system data. It defines the core of the platform that will make available data through http graphql requests (web) performing server-side processing in the services provided by the backend.

Aimed at project backend developers, database managers and administrators, data scientists, data analysts, and other stakeholders involved in the backend of the platform.

• API
  • API structure and architecture
    • Architecture
    • Functional Requirements
    • Non Functional Requirements
    • Techs, tools and frameworks used
• Tutorials to-do
• BLACK MAGE DOJOKUN important read this
• Command reference:
  • Create user account
  • Login on the system
  • [Create, retrieve, update and delete News](
  • Voting on a News TO-DO

PtBR

Nível de API

Apresenta as especificidades referentes ao pré-processamento, processamento, armazenamento e CRUD de dados do sistema. Define o core da plataforma que disponibilizará dados via requisições http graphql (web) realizando processamento server-side nos serviços disponibilizados pelo backend.

Destinado aos desenvolvedores backend do projeto, gerentes e administradores de bancos de dados, cientistas de dados, analistas de dados e demais stakeholders envolvidos no backend da plataforma.

• API todo
  • Estrutura e arquitetura da API
    • Arquitetura
    • Requisitos funcionais da API
    • Requisitos Não-Funcionais da API
    • Tecnologias utilizadas na API
• Tutoriais
• Padrões de desenvolvimento important read this
• Referências de comandos e endpoints da API:
  • Cadastrar uma conta de usuário
  • Logar no sistema
  • Criar, consultar, editar e deletar uma notícia
  • Votar em uma notícia todo

---

Wiki Changelog

Date	Name	Description	Document version
19/12/2019	Bruno L. Carli	Adds project Wiki	0.1
20/12/2019	Bruno L. Carli	Adds architecture page, API Dojokun	0.2