API-Notes

Dead simple service for publishing notes via API. Markdown supported.

The service exposes minimal API for upload markdown (with attachments) and render it as HTML.

The generated link is 16-bytes randomly generated and can be shared relatively safely.

The API-Notes is NOT serving notes - any reverse proxy must do it. With authorization if needed. See docker-compose.yaml.

Supported markdown extensions:

• GFM (GitHub Flavored Markdown)
• Footnotes
• Basic syntax highlighting
• Mermaid
• MathJax
• Embedded youtube

Installation

• Docker: ghcr.io/reddec/api-notes:latest
• Go: go install github.com/reddec/api-notes/cmd/...@latest

Usage

Usage:
  api-notes [OPTIONS] serve [serve-OPTIONS]

Help Options:
  -h, --help            Show this help message

[serve command options]
      -u, --public-url= Public URL for redirects (default: http://127.0.0.1:8080) [$API_NOTES_PUBLIC_URL]
      -b, --bind=       API binding address (default: 127.0.0.1:8080) [$API_NOTES_BIND]
      -d, --dir=        Directory to store notes (default: notes) [$API_NOTES_DIR]
      -t, --token=      Authorization token, empty means any token can be usedauth is disabled [$API_NOTES_TOKEN]

Differences in docker version

Environment variable	Default	Description
API_NOTES_BIND	0.0.0.0:8080	Binding address
API_NOTES_DIR	/data	Directory for notes

API

• OpenAPI spec
• Live docs
• generated Go API client

Example

Create note

curl -v -F author=reddec -F title=hello -F text=world -F attachment=@somefile.pdf http://127.0.0.1:8080/notes?token=deadbeaf

From Go

package main

import (
	"context"
	"log"

	"github.com/reddec/api-notes/api/client"
)

func main() {
	// we assume that we are somehow passing parameters (flags, envs...)
	const URL = "https://example.com"
	const Token = "deadbeaf"
	notes, err := client.NewClient(URL, client.HeaderToken(Token))
	if err != nil {
		// panic is used for illustration only
		panic("create notes client: " + err.Error())
	}
	note, err := notes.CreateNote(context.Background(), &client.DraftMultipart{
		Title:  "Hello",
		Text:   "## hello world\nThis is sample text",
		Author: client.NewOptString("demo"),
	})
	if err != nil {
		panic("create note: " + err.Error())
	}

	log.Println("Note ID:", note.ID)
	log.Println("Note URL:", note.PublicURL)
}

Sample note