Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarao/apiconsole
A web-based console view to manipulate APIs of an arbitrary website.
https://github.com/tarao/apiconsole
api console developer-tools golang
Last synced: 4 months ago
JSON representation
A web-based console view to manipulate APIs of an arbitrary website.
- Host: GitHub
- URL: https://github.com/tarao/apiconsole
- Owner: tarao
- License: mit
- Created: 2016-02-02T10:52:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T01:12:08.000Z (5 months ago)
- Last Synced: 2024-10-16T05:43:43.230Z (4 months ago)
- Topics: api, console, developer-tools, golang
- Language: Go
- Homepage:
- Size: 93.8 KB
- Stars: 46
- Watchers: 4
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
API Console
===========
Provide a web-based console view to manipulate APIs of an arbitrary website.
Install
-------
1. Install [golang][]
2. Run the following command
```
go get -u github.com/tarao/apiconsole
```
Console Server
--------------
Be sure that your `$GOPATH/bin` is in your `$PATH`. To manipulate the
APIs of `http://example.com/` for example, run the console server as
the following.
```
apiconsole --upstream=http://example.com
```
Now `http://localhost:8000/devel/console/` provides a console view for you.
Console View
------------
### Request URL
As long as you properly specified the upstream host, the request URL
can simply be an absolute path without an origin part. The console
server will proxy the request to the upstream host for you. Be
careful if you specify a URL starting from the origin part (scheme +
host) and the request host is different from that of the console
server. In this case, the response must come with CORS (
`Access-Control-Allow-Origin` header for example) or your browser
blocks the response.
### Response View
On Firefox, if you have an extension to prettify JSON document, JSON
responses are prettified in the console view. Unfortunately, this is
not the case for Google Chrome. If none of browser extension
prettifier is available, the console view automatically falls back to
prettifying by [highlight.js][].
LICENSE
-------
- Copyright (C) INA Lintaro
- MIT License
[golang]: https://golang.org/
[highlight.js]: https://highlightjs.org/