README
¶
Restserver
Overview
This is a sample REST server application inspired by the tutorial here. I have added an SQLite3 database as a backing store.
Installation
- Clone the git repository:
git clone git@github.com:philhanna/restserver.git
- Create a
config.ymlfile in$HOME/.config/restserver(on Windows,%appdata%\restserver)
host: localhost
port: 10000
dbname: /tmp/articles.db
dbsql: |
DROP TABLE IF EXISTS articles;
CREATE TABLE articles (
id text,
title text,
description text,
content text
);
BEGIN;
INSERT INTO articles VALUES("1", "Hello 1", "Article 1 description", "Article 1 content");
INSERT INTO articles VALUES("2", "Hello 2", "Article 2 description", "Article 2 content");
COMMIT;
Adjust the port and dbname values as needed.
References
Documentation
¶
Index ¶
- Constants
- func ConfigurationFile() (string, error)
- func Connect() (*sql.DB, error)
- func Create(w http.ResponseWriter, r *http.Request)
- func Delete(w http.ResponseWriter, r *http.Request)
- func Get(w http.ResponseWriter, r *http.Request)
- func GetAll(w http.ResponseWriter, r *http.Request)
- func HandleArticle(w http.ResponseWriter, r *http.Request)
- func HandleRequests()
- func HomePage(w http.ResponseWriter, r *http.Request)
- func Update(w http.ResponseWriter, r *http.Request)
- type Article
- type Configuration
Constants ¶
const ( PACKAGE_NAME = "restserver" YAML_FILE_NAME = "config.yml" )
Variables ¶
This section is empty.
Functions ¶
func ConfigurationFile ¶
ConfigurationFile returns the fully qualified name of the YAML file.
func Create ¶
func Create(w http.ResponseWriter, r *http.Request)
Create adds a new article to the collection, based on JSON data contained in the request. This is a POST method.
func Delete ¶
func Delete(w http.ResponseWriter, r *http.Request)
Delete gets an article number from the request and deletes the corresponding article in the collection. This is a DELETE method.
func Get ¶
func Get(w http.ResponseWriter, r *http.Request)
Get gets an article number from the request and returns the corresponding article in the collection.
func GetAll ¶
func GetAll(w http.ResponseWriter, r *http.Request)
GetAll returns the entire articles collection
func HandleArticle ¶ added in v1.1.0
func HandleArticle(w http.ResponseWriter, r *http.Request)
func HandleRequests ¶
func HandleRequests()
HandleRequests registers all the routers and starts the server.
Types ¶
type Configuration ¶
type Configuration struct {
HOST string `json:"host"`
PORT int `json:"port"`
DBNAME string `json:"dbname"`
DBSQL string `json:"dbsql"`
}
func NewConfiguration ¶
func NewConfiguration() (*Configuration, error)
NewConfiguration creates a configuration structure from the YAML file in the user configuration directory.
Source Files
Directories