Services/Projects

Generic

Introdução

Um guia simples de uso da Project G API

Convenções

A URL base para enviar todas as requisições à API é https://projectg2.vercel.app/api/. É necessário o uso de HTTPS para todas as requisições à API.

A API do Projeto G segue convenções RESTful sempre que possível, com a maioria das operações realizadas por meio de requisições GET, POST, PATCH e DELETE em recursos de página e banco de dados. Os corpos de requisição e resposta são codificados em JSON.

Convenções JSON

• Recursos de nível superior são acessíveis por meio de uma propriedade CUID "id".
• Os nomes das propriedades estão em camelCase.
• Valores temporais (datas e datetimes) são codificados em strings ISO 8601. Datetimes incluirão o valor do tempo (2020-08-12T02:12:33.231Z), enquanto datas incluirão apenas a data (2020-08-12).
• Os atributos de imagens

Code samples & SDKs

Todos recursos e código fonte então disponíveis no repositório WEB

Destacando se:

• Esquema de banco de dados (Migrações estão listadas nas pastas vizinhas)
• Biblioteca de funcionalidades
• API Config

Pasta API

Paginação

Endpoints que retornam listas de objetos suportam solicitações de paginação baseadas no seu scroll ou posição na página. Por padrão, é retornado 3 itens por chamada de API. Se o número de itens em uma resposta de um endpoint de suporte exceder o padrão, então uma integração pode usar a paginação para solicitar um conjunto específico de resultados e/ou limitar o número de itens retornados.

SUPPORTED ENDPOINTS

Limite de Requisições

Rate Limits

Caso um usuário ultrapasse o limite de requisições será retornado o código de erro: "rate_limited" (HTTP status 429). O limite atual é de em média 100 requisições por minuto.

<aside> ❗ A taxa de requisições por minuto e sua implementação provavelmente será modificada no futuro.

</aside>

Status Codes

Respostas HTTP.

Código de sucesso

Códigos de erro

Tabela de erros com seus com seus respectivos status HTTP, códigos e dados retornados

Objetos

Services/Posts (OBS: desenvolvido antes da adoção da arquitetura REST)

Trabalha com os posts de usuários

Get

Parâmetros:

• Id (opcional): ID do autor. Se fornecido, busca posts apenas do autor especificado.
• Page (opcional): Número da página para paginação. Cada página contém 3 posts.

Exemplos:

• Recuperar todos os posts: GET /api/services/posts/
• Recuperar posts de um autor específico: GET /api/services/posts/?id=authorId
• Recuperar posts paginados de um autor específico: GET /api/services/posts/?id=authorId&page=2

Response:

Um array de posts, cada um contendo as seguintes propriedades:

Exemplo em modelo prisma:

	id        String   @id @default(cuid())
  content   String?
  images    String[]
  published Boolean  @default(false)

  tags String[]

  createdAt DateTime @default(now())
  updatedAt DateTime @default(now()) @updatedAt

  likes Like[] @relation("LikedPost")
  pins  Pin[]  @relation("PinnedPost")

  author      User?     @relation("PostAuthor", fields: [authorId], references: [id], onDelete: Cascade)
  authorId    String?
  contributor User[]    @relation("PostContributor")
  comments    Comment[] @relation("CommentedPost")

Exemplo resposta em JSON:

[
	{
	   "id": "clpn00ii40001civh5f1j9ykg",
	   "content": "testye2" ,
		 "images": ["posts/imagem1.png", "posts/image2.jpg"]
	   "likes": [
	       ...
	   ],
	   ...
  },
  {
	   "id": "I'm a cuid",
	   ...
   },
]

Delete

DELETE /api/services/posts

Parâmetros:

• id (obrigatório): ID do post a ser excluído.

Exemplos:

• Excluir um post com ID "postId": DELETE /api/services/posts/?id=postId

Post

POST /api/services/posts

Parâmetros:

• id (obrigatório): ID do autor do post.

Examples:

• Um autor criando um post: POST /api/services/posts/?id=authorId

Services/User

Get

GET /api/services/users

Parâmetros:

• Não é necessário.

Exemplos:

• Requerendo Usuários: GET /api/services/users
• Requerendo apenas um: GET /api/services/users/only/:userId

Response:

Em caso de GET sem parâmetro especial (Only), é retornado uma array de usuários. Ao contrário do Uso do Only, que retorna apenas um usuário de a cordo com o Id.

Alguns dos parâmetros JSON retornados são privados, ou seja, só são retornados quando necessários.

Exemplo em modelo prisma:

	id       String  @id @default(cuid())
  name     String
  password String?
  image    String?

  followers Follows[] @relation("Follower")
  following Follows[] @relation("Following")

  likes Like[] @relation("LikedBy")
  pins  Pin[]  @relation("PinnedBy")

  title       String?
  description String?
  location    String?
  graduations String[]

  linkedinUrl  String?
  CREA         String? @unique
  siteUrl      String?
  contactPhone Int?
  profilePic   String?

  email         String    @unique
  emailVerified DateTime?

  createdAt DateTime @default(now())
  updatedAt DateTime @default(now()) @updatedAt

  position Positions @default(DefaultUser)

  accounts Account[]
  sessions Session[]

  authoredPosts    Post[] @relation("PostAuthor")
  contributedPosts Post[] @relation("PostContributor")

  authoredProjects    Project[] @relation("ProjectAuthor")
  contributedProjects Project[] @relation("ProjectContributor")

  authoredComments Comment[] @relation("CommentAuthor")

Exemplo resposta em JSON:

[
	{
	   "id": "clpn00ii40001civh5f1j9ykg" ,
	   "name": "GuizinhoLindo" ,
	   "password": "SawddsSW231455123SGWESAf2" (Private) , 
	   ...
  },
  {
	   "id": "I'm a cuid",
	   ...
   },
]

Patch

PATCH /api/services/users

Parâmetros:

• id (obrigatório): ID do usuário a ser atualizado.
• Campos a serem mudados no usuário São Passados através do body (Obrigatório).

Examples:

• Atualizar um usuário: PATCH /api/services/users/:userId

Services/Projects

Get

GET /api/services/projects

Parâmetros:

• Id (obrigatório em alguns casos).

Examples:

• Todos os projetos de um usuário: GET /api/services/projects/:userId
• Todos os projetos de uma página: GET /api/services/projects/:pageId
• Requerendo apenas um projeto: GET /api/services/users/only/:Id

Response: