https://github.com/geovaneborba/ftr-pos-api-docs

Documentação de APIs com Swagger
https://github.com/geovaneborba/ftr-pos-api-docs

api-documentation fastify node openapi-specification scalar swagger typescript zod

Last synced: 3 months ago
JSON representation

Documentação de APIs com Swagger

• Host: GitHub
• URL: https://github.com/geovaneborba/ftr-pos-api-docs
• Owner: geovaneborba
• Created: 2025-04-11T14:22:51.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2025-04-11T14:38:55.000Z (3 months ago)
• Last Synced: 2025-04-11T15:50:51.848Z (3 months ago)
• Topics: api-documentation, fastify, node, openapi-specification, scalar, swagger, typescript, zod
• Language: TypeScript
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![image](https://github.com/user-attachments/assets/45dc3757-b7ea-47e2-9b65-9d7c19619b03)



  

  

  





  Sobre   |  

  Aprendizado   |  

  Tecnologias   |  

   Pré requisitos   |  

  Começando  






## :dart: Sobre

Este projeto tem como objetivo principal a documentação de APIs seguindo as especificações da OpenAPI. Embora utilize ferramentas como Fastify e Node.js, o foco está na implementação da documentação em si, explorando conceitos do Swagger e Scalar para criar uma interface mais amigável e intuitiva para desenvolvedores. Além disso, foram implementadas ferramentas para facilitar a escrita da documentação, como o uso do Zod para serialização e validação de dados.

(Voltar para o topo)


## :books: Aprendizado

- Documentação de APIs seguindo as especificações da OpenAPI

- Swagger e Scalar para criar uma interface mais amigável e intuitiva para desenvolvedores

- Ferramentas para facilitar a escrita da documentação, como o uso do Zod para serialização e validação de dados

(Voltar para o topo)


## :rocket: Tecnologias

As seguintes tecnologias foram usadas na construção do projeto:

- [Node.js](https://nodejs.org/en/)

- [Fastify](https://fastify.dev/)

- [Zod](https://zod.dev/)

- [Swagger](https://swagger.io/)

- [Scalar](https://scalar.com/)

- [TypeScript](https://www.typescriptlang.org/)

Outras dependências e ferramentas utilizadas podem ser encontradas no arquivo [package.json](./package.json)

(Voltar para o topo)


## :warning: Pré-requisitos

Antes de começar, você precisa ter as seguintes ferramentas instaladas em sua máquina:

- [Git](https://git-scm.com)

- [Node.js](https://nodejs.org/en/)

(Voltar para o topo)


## :checkered_flag: Começando

```bash

# Clone o repositórios abaixo

$ git clone https://github.com/geovaneborba/ftr-pos-api-docs.git

# Entre na pasta e instale as dependências

$ cd ftr-pos-api-docs && npm i

# Inicie o projeto

$ npm run dev

# A documentação estará disponível em:

$ http://localhost:3000/docs

```

(Voltar para o topo)

Feito com ❤️ por Geovane Borba