Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/themihel/apiweasel

Simple API-Documentation system
https://github.com/themihel/apiweasel

api-documentation offline self-hosted

Last synced: about 1 month ago
JSON representation

Simple API-Documentation system

Host: GitHub
URL: https://github.com/themihel/apiweasel
Owner: themihel
License: mit
Created: 2015-10-24T09:32:46.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2020-04-23T10:34:32.000Z (almost 5 years ago)
Last Synced: 2024-10-26T17:22:19.950Z (3 months ago)
Topics: api-documentation, offline, self-hosted
Language: JavaScript
Size: 95.7 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # APIWeasel

[![Build status](https://api.travis-ci.org/themihel/APIWeasel.svg?branch=master)](https://travis-ci.org/themihel/APIWeasel)

![Dev-Dep](https://david-dm.org/themihel/APIWeasel/dev-status.svg?branch=master)

[![Greenkeeper badge](https://badges.greenkeeper.io/themihel/APIWeasel.svg)](https://greenkeeper.io/)

Simple API-Documentation system | [Demo](https://apiweasel.themihel.me)

![Screenshot](http://img.themihel.me/APIWeasel/apiScreen.jpg)

Easy way to display your API-Routes. Just format them in a simple JSON-File and make it accessible via APIWeasel.

# Features

- [x] Responsive design

- [x] Searchable API-Routes

- [x] Print styles

- [x] Offline mode

- [x] Install to homescreen support

- [x] Service Worker

- [x] Easy to customize

# Installation

1. Download repo

2. Install dependencies

3. Add API-Information

4. Serve or upload application

5. Offline support

## 1. Download repo

Via 'git clone' or 'download .zip'.

## 2. Install dependencies

Run the following commands

```

npm install

bower install

```

## 3. Add API-Information

Change the example api.json file with your specific information.

## 4. Serve or upload application

### Local:

Run the following command to test this package on your local machine:

```

gulp serve

```

### Deployment

For deploying this package first run:

```

gulp dist

```

and upload all files from the /dist directory to your server!

## 5. Offline support

HTTPS Connection is needed for offline support