https://github.com/joaomede/Api-Doc

A Technology for Rest API Documentation :computer: :scroll: "Dockerized"
https://github.com/joaomede/Api-Doc

api client-electron docker docker-compose documentation documentation-tool express quasar quasar-framework register rest rest-api vuejs

Last synced: 8 days ago
JSON representation

A Technology for Rest API Documentation :computer: :scroll: "Dockerized"

• Host: GitHub
• URL: https://github.com/joaomede/Api-Doc
• Owner: joaomede
• License: mit
• Created: 2019-12-26T15:45:34.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-22T13:03:27.000Z (over 1 year ago)
• Last Synced: 2024-08-02T00:25:44.720Z (3 months ago)
• Topics: api, client-electron, docker, docker-compose, documentation, documentation-tool, express, quasar, quasar-framework, register, rest, rest-api, vuejs
• Language: Vue
• Homepage: https://hub.docker.com/r/joaomede/apidoc
• Size: 4.59 MB
• Stars: 15
• Watchers: 2
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• quasar-awesome - github

README

        


  





    

        

    

    

        

    

    

        

    

        

        

    

    

    

        

    

    

        

    

    

        

    

    

        

    



API Doc is an API Rest test technology, it works as a CRUD, where you can access the documentation from anywhere, I was inspired by applications like Swagger, Postman and Insonmia to create it.

### Mobile - (Cordova or PWA)

|              Main Menu              |              List Api               |                Paths                |

| :---------------------------------: | :---------------------------------: | :---------------------------------: |

| ![](documentation/docs/image/1.png) | ![](documentation/docs/image/2.png) | ![](documentation/docs/image/3.png) |



### Client Electron for Desktop

![Destkop Electron](documentation/docs/image/electronDesktop.png)

> Attention: Cordova and Electron Builds ask for the address of a Remote API, they work only as customers, while the PWA version does not make this requirement, as it runs in the same container as the API - for more, see in docs ["Cordova And Electron Docs"](https://joaomede.github.io/Api-Doc/pages/CordovaAndElectron.html)

## Get Started

### See Full [Documentation](https://joaomede.github.io/Api-Doc)

### Need to get started fast? go docker [Docker Compose Settings](https://joaomede.github.io/Api-Doc/pages/Docker.html)

[![dockeri.co](https://dockeri.co/image/joaomede/apidoc)](https://hub.docker.com/r/joaomede/apidoc)

### Features

- [x] Dockerized? Yes!

- [x] Login and Register, Change Password

- [x] Team System

- [x] Api Documentation "private and public"

- [x] Client Electron for Windows, Mac And Linux Dist

- [x] PWA/SPA Works

- [ ] SSR Builder

- [x] Cordova Android

- [ ] Cordova iOS

- [x] Test Request

- [x] Register Responses and Codes Definitions

- [x] Methods Accept: Post, Get, Delete, Put

- [x] Accept: Headers, Params Path and Body

- [x] Accept: Query Params

- [ ] Accept: DataForm, in Dev

## License

[MIT](LICENSE)