README
¶
bbolt API
This is a simple REST API for interacting with bbolt. The server looks for an environment variable named DATABASE_PATH
and an environment variable named SERVER_PORT.
The server only opens one database. The server is lightweight, so if you need more than one database you can just run another server.
API Documentation
Visit the Docs site
The application now has an API explorer built in using the Swagger UI. It's located at /v1/docs/.
Running With Docker
docker run -d --name api -v bolt-volume:/database -p 8080:8080 hooksie1/bbolt-api:v0.0.4
The container automatically stores the database named bolt.db in /database. Mount a volume
to /database to store locally.
Documentation
¶
Overview ¶
Copyright © 2021 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories