Documentação do Projeto Backend

Visão Geral

Esta documentação descreve o backend da aplicação web [Nome do Projeto]. O backend é responsável por gerenciar os dados e a lógica de negócio da aplicação.

Tecnologias Utilizadas

Django: Framework web em Python utilizado para o desenvolvimento do backend.
Django Rest Framework: Biblioteca que facilita a criação de APIs RESTful com Django.
MySQL: Sistema de gerenciamento de banco de dados relacional utilizado para armazenar os dados da aplicação.

Estrutura do Projeto

O projeto backend está estruturado da seguinte forma:

backend/
├── app1/ # Aplicação principal
│ ├── migrations/ # Migrations da aplicação
│ ├── models.py # Definição dos modelos de dados
│ ├── views.py # Views da aplicação
│ └── ...
├── app2/ # Outra aplicação (se aplicável)
│ └── ...
├── settings.py # Configurações do projeto Django
└── ...

Configuração do Ambiente de Desenvolvimento

Para configurar o ambiente de desenvolvimento, siga os passos abaixo:

Clone o repositório do projeto: git clone https://github.com/seu-usuario/backend.git
Crie um ambiente virtual: python -m venv venv
Ative o ambiente virtual: source venv/bin/activate (Linux/Mac) ou venv\Scripts\activate (Windows)
Instale as dependências do projeto: pip install -r requirements.txt
Execute as migrações do banco de dados: python manage.py migrate
Inicie o servidor de desenvolvimento: python manage.py runserver

Documentação da API

A API do backend fornece os seguintes endpoints principais:

/api/resource/: Descrição do recurso e sua funcionalidade.
/api/resource/<id>/: Descrição do recurso específico e sua funcionalidade.

URL Search Params | query string parameters

api_key | demo: DEMO_KEY | https://api.nasa.gov/#signUp
date A string in YYYY-MM-DD format indicating the date of the APOD image (example: 2014-11-03). Defaults to today's date. Must be after 1995-06-16, the first day an APOD picture was posted. There are no images for tomorrow available through this API.
concept_tags A boolean True|False indicating whether concept tags should be returned with the rest of the response. The concept tags are not necessarily included in the explanation, but rather derived from common search tags that are associated with the description text. (Better than just pure text search.) Defaults to False.

Returned fields

title The title of the image.
date Date of image. Included in response because of default values.
url The URL of the APOD image or video of the day.

Exemplos

localhost:5000/v1/apod?api_key=DEMO_KEY&date=2014-10-01&concept_tags=True

See Return Object

```jsoniq { resource: { image_set: "apod" }, concept_tags: "True", date: "2013-10-01", title: "Filaments of the Vela Supernova Remnant", url: "http://apod.nasa.gov/apod/image/1310/velafilaments_jadescope_960.jpg", explanation: "The explosion is over but the consequences continue. About eleven thousand years ago a star in the constellation of Vela could be seen to explode, creating a strange point of light briefly visible to humans living near the beginning of recorded history. The outer layers of the star crashed into the interstellar medium, driving a shock wave that is still visible today. A roughly spherical, expanding shock wave is visible in X-rays. The above image captures some of that filamentary and gigantic shock in visible light. As gas flies away from the detonated star, it decays and reacts with the interstellar medium, producing light in many different colors and energy bands. Remaining at the center of the Vela Supernova Remnant is a pulsar, a star as dense as nuclear matter that rotates completely around more than ten times in a single second.", concepts: { 0: "Astronomy", 1: "Star", 2: "Sun", 3: "Milky Way", 4: "Hubble Space Telescope", 5: "Earth", 6: "Nebula", 7: "Interstellar medium" } } ```

GustavoMartinx / Nasa-Apod-Gallery-Back

Criar documentação do backend #5

Tarefas para a criação da documentação/readme do projeto de backend do NAG: