2022-03-28 15:03:21 +02:00
|
|
|
#+title: :lang rest
|
|
|
|
|
#+subtitle: Emacs as a REST client
|
|
|
|
|
#+created: February 20, 2017
|
|
|
|
|
#+since: 2.0.0
|
2021-10-16 01:28:32 +02:00
|
|
|
|
|
|
|
|
* 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~)
|
2017-05-07 02:43:09 +02:00
|
|
|
|
2017-05-25 20:08:50 +02:00
|
|
|
#+begin_quote
|
2021-10-16 01:28:32 +02:00
|
|
|
💡 ~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.
|
2017-05-25 20:08:50 +02:00
|
|
|
#+end_quote
|
|
|
|
|
|
2020-03-27 20:16:02 -04:00
|
|
|
** Maintainers
|
2021-10-16 01:28:32 +02:00
|
|
|
- [[doom-user:][@hlissner]]
|
2020-03-27 20:16:02 -04:00
|
|
|
|
2021-10-16 01:28:32 +02:00
|
|
|
[[doom-contrib-maintainer:][Become a maintainer?]]
|
2020-03-27 20:16:02 -04:00
|
|
|
|
2021-10-16 01:28:32 +02:00
|
|
|
** Module flags
|
2022-08-02 16:26:33 +02:00
|
|
|
- +jq ::
|
|
|
|
|
Enable native support for reading and processing REST responses with jq.
|
|
|
|
|
*Requires the =jq= command line utility.*
|
2021-10-16 01:28:32 +02:00
|
|
|
|
|
|
|
|
** Packages
|
|
|
|
|
- [[doom-package:][company-restclient]] if [[doom-module:][:completion company]]
|
|
|
|
|
- [[doom-package:][restclient]]
|
2022-08-02 16:26:33 +02:00
|
|
|
- if [[doom-module:][+jq]]
|
|
|
|
|
- [[doom-package:][restclient-jq]]
|
|
|
|
|
- [[doom-package:][jq-mode]]
|
2020-03-27 20:16:02 -04:00
|
|
|
|
|
|
|
|
** Hacks
|
2021-10-16 01:28:32 +02:00
|
|
|
- Adds imenu support to ~restclient-mode~.
|
|
|
|
|
- [[doom-package:][restclient]] has been modified not to silently reject self-signed or invalid
|
2020-03-27 20:16:02 -04:00
|
|
|
certificates.
|
|
|
|
|
|
2021-10-16 01:28:32 +02:00
|
|
|
** TODO Changelog
|
|
|
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
|
|
|
/This module does not have a changelog yet./
|
2020-03-27 20:16:02 -04:00
|
|
|
|
2021-10-16 01:28:32 +02:00
|
|
|
* Installation
|
|
|
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
2020-03-27 20:16:02 -04:00
|
|
|
|
2021-10-16 01:28:32 +02:00
|
|
|
/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
|
2020-03-27 20:16:02 -04:00
|
|
|
|
|
|
|
|
* Troubleshooting
|
2021-10-16 01:28:32 +02:00
|
|
|
/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
|
