RestApiTutorial.com is a Hugo-powered documentation website template that teaches REST API design, provides an HTTP status codes reference, and ships the source code plus downloadable PDF/ePub/Mobi/ODT versions of the RESTful Best Practices guide.
What is RestApiTutorial.com?
RestApiTutorial.com is the HTML source repository for the public site at www.RestApiTutorial.com. It is built with the Hugo static site generator (pinned to v0.147.7) and the Hugo-Relearn theme v8.3.0, and it includes a media/ directory holding the book formats (PDF, ePub, Mobi, ODT) for the RESTful Best Practices document. The project is open source under the Creative Commons Attribution-ShareAlike 4.0 International License.
Key Features
- Hugo v0.147.7 with vendored binary — The repo includes a project-local
./bin/hugowrapper and atools/hugo/directory; contributors download the extended Hugo binary intotools/before building. - Hugo-Relearn theme v8.3.0 — The site uses a fixed theme version, and the README warns that later versions may break the build.
- Downloadable book formats — The
media/folder stores PDF, ePub, Mobi, and ODT versions of the RESTful Best Practices document. - AdSense integration — Ad units are configured through
params.adsenseinconfig.toml; the top ad renders inlayouts/partials/heading-pre.htmland the bottom ad inlayouts/partials/content.html, with per-page opt-out viadisableTopAdanddisableBottomAdfront matter. - Predictable project layout —
content/stores Hugo pages,layouts/holds theme overrides,static/copies assets verbatim,public/is generated output, andtools/contains internal helpers. - Contributor onboarding — An
AGENTS.mdfile documents the change process, and the README provides download commands for Hugo 0.147.7 on macOS, Linux x86_64, and Linux arm64.
Who is it for?
RestApiTutorial.com serves API designers, developers, and technical writers who need a clear REST API reference. Self-hosters and Hugo users can use the repository as a working example of the Hugo-Relearn theme with AdSense and multi-format publishing.
What can you do with RestApiTutorial.com?
- API designers: Consult the REST API tutorial pages and the HTTP Status Codes reference at
restapitutorial.com/httpstatuscodes.htmlto choose correct HTTP methods and status codes. - Offline readers: Download the RESTful Best Practices guide as PDF, ePub, Mobi, or ODT from the
media/directory and read it on any device. - Hugo maintainers: Run
./bin/hugo server -Dfor local development, edit content in Markdown, and produce a static site with the Relearn theme.
How does RestApiTutorial.com work?
The site is built from Markdown content in content/ that Hugo processes into static HTML. The bin/hugo wrapper invokes the vendored Hugo binary from tools/hugo, ensuring a reproducible build. Ad slots are injected by theme partials that read params.adsense from config.toml; each page can disable either or both ads using front matter.
FAQ
Is RestApiTutorial.com free to use?
Yes, the project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License, so you can reuse, adapt, and republish the material as long as you attribute RestApiTutorial.com and share your derivative work under the same license.
What Hugo version does this template require?
The pinned version is Hugo extended v0.147.7, and the README warns that later versions may break the build. You must place the Hugo binary in tools/hugo before running the local server.
How do I disable ads on a particular page?
Add disableTopAd: true and/or disableBottomAd: true to the page's front matter. The top ad partial (layouts/partials/heading-pre.html) and bottom ad partial (layouts/partials/content.html) will check these flags and skip rendering the ad.
Where do the downloadable book files live?
The media/ directory contains the PDF, ePub, Mobi, and ODT versions of the RESTful Best Practices document. These files are part of the repository and are linked from the tutorial content.
