Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.2.3

May 21, 2026

v0.2.2

Mar 11, 2026

v0.2.1

Mar 8, 2026

Changes in this version

type Config

+ StaticFS fs.FS

v0.2.0

Mar 7, 2026

v0.1.0

Mar 4, 2026

Changes in this version

+ type API struct

+ func New(cfg Config, svc Service, views ViewRenderer) (*API, error)

+ func (a *API) Run(ctx context.Context) error

+ type Config struct

+ APIKeys []string

+ Listen string

+ MaxIngestBodyMiB int64

+ type MockService struct

+ func NewMockService(t interface{ ... }) *MockService

+ func (_m *MockService) EXPECT() *MockService_Expecter

+ func (_m *MockService) GetAsset(ctx context.Context, repo string, path string) ([]byte, error)

+ func (_m *MockService) GetDocument(ctx context.Context, repo string, path string) (core.Document, []byte, []core.Heading, error)

+ func (_m *MockService) IngestDocuments(ctx context.Context, req *core.IngestRequest) (*core.IngestResponse, error)

+ func (_m *MockService) ListDocuments(ctx context.Context, repo string) ([]core.DocumentMeta, error)

+ func (_m *MockService) ListRepos(ctx context.Context) ([]core.RepoInfo, error)

+ func (_m *MockService) SearchDocs(ctx context.Context, query string, opts core.SearchOpts) (*core.SearchResults, error)

+ type MockService_Expecter struct

+ func (_e *MockService_Expecter) GetAsset(ctx interface{}, repo interface{}, path interface{}) *MockService_GetAsset_Call

+ func (_e *MockService_Expecter) GetDocument(ctx interface{}, repo interface{}, path interface{}) *MockService_GetDocument_Call

+ func (_e *MockService_Expecter) IngestDocuments(ctx interface{}, req interface{}) *MockService_IngestDocuments_Call

+ func (_e *MockService_Expecter) ListDocuments(ctx interface{}, repo interface{}) *MockService_ListDocuments_Call

+ func (_e *MockService_Expecter) ListRepos(ctx interface{}) *MockService_ListRepos_Call

+ func (_e *MockService_Expecter) SearchDocs(ctx interface{}, query interface{}, opts interface{}) *MockService_SearchDocs_Call

+ type MockService_GetAsset_Call struct

+ func (_c *MockService_GetAsset_Call) Return(_a0 []byte, _a1 error) *MockService_GetAsset_Call

+ func (_c *MockService_GetAsset_Call) Run(run func(ctx context.Context, repo string, path string)) *MockService_GetAsset_Call

+ func (_c *MockService_GetAsset_Call) RunAndReturn(run func(context.Context, string, string) ([]byte, error)) *MockService_GetAsset_Call

+ type MockService_GetDocument_Call struct

+ func (_c *MockService_GetDocument_Call) Return(_a0 core.Document, _a1 []byte, _a2 []core.Heading, _a3 error) *MockService_GetDocument_Call

+ func (_c *MockService_GetDocument_Call) Run(run func(ctx context.Context, repo string, path string)) *MockService_GetDocument_Call

+ func (_c *MockService_GetDocument_Call) RunAndReturn(...) *MockService_GetDocument_Call

+ type MockService_IngestDocuments_Call struct

+ func (_c *MockService_IngestDocuments_Call) Return(_a0 *core.IngestResponse, _a1 error) *MockService_IngestDocuments_Call

+ func (_c *MockService_IngestDocuments_Call) Run(run func(ctx context.Context, req *core.IngestRequest)) *MockService_IngestDocuments_Call

+ func (_c *MockService_IngestDocuments_Call) RunAndReturn(run func(context.Context, *core.IngestRequest) (*core.IngestResponse, error)) *MockService_IngestDocuments_Call

+ type MockService_ListDocuments_Call struct

+ func (_c *MockService_ListDocuments_Call) Return(_a0 []core.DocumentMeta, _a1 error) *MockService_ListDocuments_Call

+ func (_c *MockService_ListDocuments_Call) Run(run func(ctx context.Context, repo string)) *MockService_ListDocuments_Call

+ func (_c *MockService_ListDocuments_Call) RunAndReturn(run func(context.Context, string) ([]core.DocumentMeta, error)) *MockService_ListDocuments_Call

+ type MockService_ListRepos_Call struct

+ func (_c *MockService_ListRepos_Call) Return(_a0 []core.RepoInfo, _a1 error) *MockService_ListRepos_Call

+ func (_c *MockService_ListRepos_Call) Run(run func(ctx context.Context)) *MockService_ListRepos_Call

+ func (_c *MockService_ListRepos_Call) RunAndReturn(run func(context.Context) ([]core.RepoInfo, error)) *MockService_ListRepos_Call

+ type MockService_SearchDocs_Call struct

+ func (_c *MockService_SearchDocs_Call) Return(_a0 *core.SearchResults, _a1 error) *MockService_SearchDocs_Call

+ func (_c *MockService_SearchDocs_Call) Run(run func(ctx context.Context, query string, opts core.SearchOpts)) *MockService_SearchDocs_Call

+ func (_c *MockService_SearchDocs_Call) RunAndReturn(...) *MockService_SearchDocs_Call

+ type MockViewRenderer struct

+ func NewMockViewRenderer(t interface{ ... }) *MockViewRenderer

+ func (_m *MockViewRenderer) EXPECT() *MockViewRenderer_Expecter

+ func (_m *MockViewRenderer) RenderDoc(w io.Writer, doc core.Document, html []byte, headings []core.Heading, ...) error

+ func (_m *MockViewRenderer) RenderHome(w io.Writer, repos []core.RepoInfo, partial bool) error

+ func (_m *MockViewRenderer) RenderNotFound(w io.Writer) error

+ func (_m *MockViewRenderer) RenderRepoIndex(w io.Writer, repo string, docs []core.DocumentMeta, partial bool) error

+ func (_m *MockViewRenderer) RenderSearch(w io.Writer, query string, results *core.SearchResults, partial bool) error

+ type MockViewRenderer_Expecter struct

+ func (_e *MockViewRenderer_Expecter) RenderDoc(w interface{}, doc interface{}, html interface{}, headings interface{}, ...) *MockViewRenderer_RenderDoc_Call

+ func (_e *MockViewRenderer_Expecter) RenderHome(w interface{}, repos interface{}, partial interface{}) *MockViewRenderer_RenderHome_Call

+ func (_e *MockViewRenderer_Expecter) RenderNotFound(w interface{}) *MockViewRenderer_RenderNotFound_Call

+ func (_e *MockViewRenderer_Expecter) RenderRepoIndex(w interface{}, repo interface{}, docs interface{}, partial interface{}) *MockViewRenderer_RenderRepoIndex_Call

+ func (_e *MockViewRenderer_Expecter) RenderSearch(w interface{}, query interface{}, results interface{}, partial interface{}) *MockViewRenderer_RenderSearch_Call

+ type MockViewRenderer_RenderDoc_Call struct

+ func (_c *MockViewRenderer_RenderDoc_Call) Return(_a0 error) *MockViewRenderer_RenderDoc_Call

+ func (_c *MockViewRenderer_RenderDoc_Call) Run(...) *MockViewRenderer_RenderDoc_Call

+ func (_c *MockViewRenderer_RenderDoc_Call) RunAndReturn(...) *MockViewRenderer_RenderDoc_Call

+ type MockViewRenderer_RenderHome_Call struct

+ func (_c *MockViewRenderer_RenderHome_Call) Return(_a0 error) *MockViewRenderer_RenderHome_Call

+ func (_c *MockViewRenderer_RenderHome_Call) Run(run func(w io.Writer, repos []core.RepoInfo, partial bool)) *MockViewRenderer_RenderHome_Call

+ func (_c *MockViewRenderer_RenderHome_Call) RunAndReturn(run func(io.Writer, []core.RepoInfo, bool) error) *MockViewRenderer_RenderHome_Call

+ type MockViewRenderer_RenderNotFound_Call struct

+ func (_c *MockViewRenderer_RenderNotFound_Call) Return(_a0 error) *MockViewRenderer_RenderNotFound_Call

+ func (_c *MockViewRenderer_RenderNotFound_Call) Run(run func(w io.Writer)) *MockViewRenderer_RenderNotFound_Call

+ func (_c *MockViewRenderer_RenderNotFound_Call) RunAndReturn(run func(io.Writer) error) *MockViewRenderer_RenderNotFound_Call

+ type MockViewRenderer_RenderRepoIndex_Call struct

+ func (_c *MockViewRenderer_RenderRepoIndex_Call) Return(_a0 error) *MockViewRenderer_RenderRepoIndex_Call

+ func (_c *MockViewRenderer_RenderRepoIndex_Call) Run(run func(w io.Writer, repo string, docs []core.DocumentMeta, partial bool)) *MockViewRenderer_RenderRepoIndex_Call

+ func (_c *MockViewRenderer_RenderRepoIndex_Call) RunAndReturn(run func(io.Writer, string, []core.DocumentMeta, bool) error) *MockViewRenderer_RenderRepoIndex_Call

+ type MockViewRenderer_RenderSearch_Call struct

+ func (_c *MockViewRenderer_RenderSearch_Call) Return(_a0 error) *MockViewRenderer_RenderSearch_Call

+ func (_c *MockViewRenderer_RenderSearch_Call) Run(run func(w io.Writer, query string, results *core.SearchResults, partial bool)) *MockViewRenderer_RenderSearch_Call

+ func (_c *MockViewRenderer_RenderSearch_Call) RunAndReturn(run func(io.Writer, string, *core.SearchResults, bool) error) *MockViewRenderer_RenderSearch_Call

+ type Service interface

+ GetAsset func(ctx context.Context, repo, path string) ([]byte, error)

+ GetDocument func(ctx context.Context, repo, path string) (core.Document, []byte, []core.Heading, error)

+ IngestDocuments func(ctx context.Context, req *core.IngestRequest) (*core.IngestResponse, error)

+ ListDocuments func(ctx context.Context, repo string) ([]core.DocumentMeta, error)

+ ListRepos func(ctx context.Context) ([]core.RepoInfo, error)

+ SearchDocs func(ctx context.Context, query string, opts core.SearchOpts) (*core.SearchResults, error)

+ type ViewRenderer interface

+ RenderDoc func(w io.Writer, doc core.Document, html []byte, headings []core.Heading, ...) error

+ RenderHome func(w io.Writer, repos []core.RepoInfo, partial bool) error

+ RenderNotFound func(w io.Writer) error

+ RenderRepoIndex func(w io.Writer, repo string, docs []core.DocumentMeta, partial bool) error

+ RenderSearch func(w io.Writer, query string, results *core.SearchResults, partial bool) error