Get Started

REST API Reference

LetXUpdated MIT
Open full PDF

 

About this template

A REST API reference in Lato with Inconsolata code, documenting project and task endpoints with example requests and responses, and a table of status codes.

Tags

tech-docslatex
Preview

What is in this template

Read from the source files of this template.

Document class
article [11pt]
Compiles with
pdfLaTeX
Pages in the compiled PDF
2
Bibliography
None
Files
6 files: 5 .tex, 1 image
Packages
  • geometry
  • fontenc
  • lato
  • inconsolata
  • amsmath
  • xcolor
  • colortbl
  • booktabs
  • tabularx
  • array
  • titlesec
  • listings
  • tcolorbox
  • fancyhdr
  • hyperref
The preamble of main.tex, from \documentclass to \begin{document}.
\documentclass[11pt]{article}

% Packages and styling live in preamble.tex; each section has its own file under
% sections/. Edit those directly --- this file is the outline of the document.
\input{preamble}

% Lets TeX stretch interword space on a line it cannot otherwise break, instead of
% running past the margin. Affects only lines that would overflow.
\setlength{\emergencystretch}{3em}

Put this template on your own page

Open in LetX

Paste this badge on a thesis guide, a course page or a README. One click opens the template as a new project in the reader's own LetX account.

Markdown
[![Open in LetX](https://letx.app/badges/open-in-letx.svg)](https://letx.app/open?template=rest-api-reference)
HTML
<a href="https://letx.app/open?template=rest-api-reference"><img src="https://letx.app/badges/open-in-letx.svg" alt="Open in LetX"></a>
About the Open in LetX badge

Frequently asked questions

What does the REST API Reference template load?

It uses the article class (options: 11pt), builds with pdfLaTeX, and loads 15 packages, including geometry, fontenc, lato, inconsolata, amsmath, xcolor, colortbl and booktabs.

How long is the REST API Reference sample?

The compiled sample is 2 pages, from 6 files: 5 .tex, 1 image. Replace the sample text with yours and the layout stays.

Is the REST API Reference template free to use online?

Yes. "Open as Template" makes it your own LetX project: edit the LaTeX in the browser, invite collaborators to edit with you in real time, and download the compiled PDF. There is nothing to install.

Working out which one you need?

LaTeX templates for technical documentationRFCs, runbooks, datasheets and API references.

More Technical Docs templates

API Reference DocumentationTechnical DocsEmbedded Firmware Technical ReferenceTechnical DocsGraphQL API ReferenceTechnical DocsDevOps Infrastructure RunbookTechnical DocsSoftware Release NotesTechnical DocsNetwork Topography & Routing GuideTechnical Docs

\begin{now}

Start writing with REST API Reference, free, in your browser, with real-time collaboration.