Awesome
<p align="center"> <img src="./view/src/statics/app-logo-512x512.png"height="130"> </p> <p align="center"> <a href="http://commitizen.github.io/cz-cli/" alt="Commitizen friendly"> <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" /> </a> <a href="https://img.shields.io/github/workflow/status/joaomede/Api-Doc/main?label=Build%20API" alt="Build Api"> <img src="https://img.shields.io/github/workflow/status/joaomede/Api-Doc/main?label=Build%20API" /> </a> <a href="https://travis-ci.com/joaomede/Api-Doc" alt="Build Status"> <img src="https://travis-ci.com/joaomede/Api-Doc.svg?branch=master" /> </a> <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/joaomede/Api-Doc"> <a href="https://img.shields.io/github/license/joaomede/api-doc" alt="GitHub repo size"> <img src="https://img.shields.io/github/repo-size/joaomede/api-doc" /> </a> <img alt="GitHub" src="https://img.shields.io/github/license/joaomede/Api-Doc"> <a href="https://www.codacy.com/manual/joaomede/Api-Doc?utm_source=github.com&utm_medium=referral&utm_content=joaomede/Api-Doc&utm_campaign=Badge_Grade" alt="Codacy Badge"> <img src="https://api.codacy.com/project/badge/Grade/cb8e4c89586a43809c7a817a07f56309" /> </a> <a href="https://sourceforge.net/projects/api-doc/files/Api%20Doc-2.1.6.AppImage/download" alt="Linux Client"> <img src="https://img.shields.io/badge/Linux_Client:_AppImage-v2.1.5-blue.svg" /> </a> <a href="https://sourceforge.net/projects/api-doc/files/Api%20Doc%202.1.5.exe/download" alt="Windows Client"> <img src="https://img.shields.io/badge/Windows_Client:_Setup_EXE-v2.1.5-blue.svg" /> </a> <a href="https://sourceforge.net/projects/api-doc/files/ApiDoc-2.1.6.apk/download" alt="Android Cordova"> <img src="https://img.shields.io/badge/Android_Cordova:_APK-v2.1.6-blue.svg" /> </a> </p>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 |
|---|---|---|
 |  |  |
<a href="https://www.buymeacoffee.com/iSTozIC" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/lato-blue.png" alt="Buy Me A Coffee" style="height: 35px !important;width: 150px !important;" ></a>
Client Electron for Desktop
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"
Get Started
See Full Documentation
Need to get started fast? go docker Docker Compose Settings
Features
- Dockerized? Yes!
- Login and Register, Change Password
- Team System
- Api Documentation "private and public"
- Client Electron for Windows, Mac And Linux Dist
- PWA/SPA Works
- SSR Builder
- Cordova Android
- Cordova iOS
- Test Request
- Register Responses and Codes Definitions
- Methods Accept: Post, Get, Delete, Put
- Accept: Headers, Params Path and Body
- Accept: Query Params
- Accept: DataForm, in Dev