doomemacs/modules/lang/rest/README.org

#+title:    :lang rest
#+subtitle: Emacs as a REST client
#+created:  February 20, 2017
#+since:    2.0.0

* Description :unfold:
This module turns Emacs into a [[https://en.wikipedia.org/wiki/Representational_state_transfer][REST]] client.

- Code-completion (~company-restclient~)
- Code evaluation
- Imenu support for ~restclient-mode~
- org-mode: babel support (~ob-restclient~)

#+begin_quote
 💡 ~restclient-mode~ is tremendously useful for automated or quick testing REST
    APIs. My workflow is to open an ~org-mode~ buffer, create a restclient
    source block and hack away. ~restclient-mode~ and ~company-restclient~ power
    this arcane wizardry.
#+end_quote

** Maintainers
- [[doom-user:][@hlissner]]

[[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
- +jq ::
  Enable native support for reading and processing REST responses with jq.
  *Requires the =jq= command line utility.*

** Packages
- [[doom-package:company-restclient]] if [[doom-module::completion company]]
- [[doom-package:restclient]]
- if [[doom-module:+jq]]
  - [[doom-package:restclient-jq]]
  - [[doom-package:jq-mode]]

** Hacks
- Adds imenu support to ~restclient-mode~.
- [[doom-package:restclient]] has been modified not to silently reject self-signed or invalid
  certificates.

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

/This module has no external requirements./

* TODO Usage
#+begin_quote
 󱌣 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* TODO Configuration
#+begin_quote
 󱌣 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote