index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. <!DOCTYPE html>
  2. <html lang="en" data-base-path="&#x2F;cpp-httplib">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <title>Getting Started - cpp-httplib</title>
  7. <link rel="stylesheet" href="&#x2F;cpp-httplib/css/main.css">
  8. <script>
  9. (function() {
  10. var t = localStorage.getItem('preferred-theme');
  11. if (!t) t = window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark';
  12. if (t === 'light') document.documentElement.setAttribute('data-theme', 'light');
  13. })();
  14. </script>
  15. </head>
  16. <body>
  17. <header class="header">
  18. <div class="header-inner">
  19. <a href="&#x2F;cpp-httplib/en/" class="header-title">cpp-httplib <span style="font-size:0.75em;font-weight:normal;margin-left:4px">v0.35.0</span></a>
  20. <div class="header-spacer"></div>
  21. <nav class="header-nav">
  22. <a href="&#x2F;cpp-httplib/en/">Home</a>
  23. <a href="&#x2F;cpp-httplib/en/tour/">Tour</a>
  24. <a href="https://github.com/yhirose/cpp-httplib">GitHub</a>
  25. </nav>
  26. <div class="header-tools">
  27. <button class="theme-toggle" aria-label="Toggle theme"></button>
  28. <div class="lang-selector">
  29. <button class="lang-btn" aria-label="Language">EN</button>
  30. <ul class="lang-popup">
  31. <li><a href="#" data-lang="en">EN</a></li>
  32. <li><a href="#" data-lang="ja">JA</a></li>
  33. </ul>
  34. </div>
  35. </div>
  36. <button class="sidebar-toggle" aria-label="Menu">&#9776;</button>
  37. </div>
  38. </header>
  39. <div class="layout has-sidebar">
  40. <aside class="sidebar">
  41. <nav class="sidebar-nav">
  42. <div class="nav-section">
  43. <a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;" class="nav-section-title active">A Tour of cpp-httplib</a>
  44. <ul class="nav-list">
  45. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;01-getting-started&#x2F;" class="active">Getting Started</a></li>
  46. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;02-basic-client&#x2F;" class="">Basic Client</a></li>
  47. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;03-basic-server&#x2F;" class="">Basic Server</a></li>
  48. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;04-static-file-server&#x2F;" class="">Static File Server</a></li>
  49. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;05-tls-setup&#x2F;" class="">TLS Setup</a></li>
  50. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;06-https-client&#x2F;" class="">HTTPS Client</a></li>
  51. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;07-https-server&#x2F;" class="">HTTPS Server</a></li>
  52. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;08-websocket&#x2F;" class="">WebSocket</a></li>
  53. <li><a href="&#x2F;cpp-httplib&#x2F;en&#x2F;tour&#x2F;09-whats-next&#x2F;" class="">What&#x27;s Next</a></li>
  54. </ul>
  55. </div>
  56. </nav>
  57. </aside>
  58. <main class="content">
  59. <article>
  60. <h1>Getting Started</h1>
  61. <p>All you need to get started with cpp-httplib is <code>httplib.h</code> and a C++ compiler. Let's download the file and get a Hello World server running.</p>
  62. <h2>Getting httplib.h</h2>
  63. <p>You can download it directly from GitHub. Always use the latest version.</p>
  64. <div class="code-dark"><pre style="background-color:#2d2d2d;">
  65. <span style="color:#6699cc;">curl</span><span style="color:#f2777a;"> -LO</span><span style="color:#d3d0c8;"> https://github.com/yhirose/cpp-httplib/raw/refs/tags/latest/httplib.h
  66. </span></pre>
  67. </div><div class="code-light"><pre style="background-color:#eff1f5;">
  68. <span style="color:#8fa1b3;">curl</span><span style="color:#bf616a;"> -LO</span><span style="color:#4f5b66;"> https://github.com/yhirose/cpp-httplib/raw/refs/tags/latest/httplib.h
  69. </span></pre>
  70. </div>
  71. <p>Place the downloaded <code>httplib.h</code> in your project directory and you're good to go.</p>
  72. <h2>Setting Up Your Compiler</h2>
  73. <table><thead><tr><th>OS</th><th>Development Environment</th><th>Setup</th></tr></thead><tbody>
  74. <tr><td>macOS</td><td>Apple Clang</td><td>Xcode Command Line Tools (<code>xcode-select --install</code>)</td></tr>
  75. <tr><td>Ubuntu</td><td>clang++ or g++</td><td><code>apt install clang</code> or <code>apt install g++</code></td></tr>
  76. <tr><td>Windows</td><td>MSVC</td><td>Visual Studio 2022 or later (install with C++ components)</td></tr>
  77. </tbody></table>
  78. <h2>Hello World Server</h2>
  79. <p>Save the following code as <code>server.cpp</code>.</p>
  80. <div class="code-dark"><pre style="background-color:#2d2d2d;">
  81. <span style="color:#cc99cc;">#include </span><span style="color:#d3d0c8;">&quot;</span><span style="color:#99cc99;">httplib.h</span><span style="color:#d3d0c8;">&quot;
  82. </span><span style="color:#d3d0c8;">
  83. </span><span style="color:#cc99cc;">int </span><span style="color:#6699cc;">main</span><span style="color:#d3d0c8;">() {
  84. </span><span style="color:#d3d0c8;"> httplib::Server svr;
  85. </span><span style="color:#d3d0c8;">
  86. </span><span style="color:#d3d0c8;"> svr.</span><span style="color:#6699cc;">Get</span><span style="color:#d3d0c8;">(&quot;</span><span style="color:#99cc99;">/</span><span style="color:#d3d0c8;">&quot;, [](</span><span style="color:#cc99cc;">const</span><span style="color:#d3d0c8;"> httplib::Request&amp;, httplib::Response&amp; res) {
  87. </span><span style="color:#d3d0c8;"> res.</span><span style="color:#6699cc;">set_content</span><span style="color:#d3d0c8;">(&quot;</span><span style="color:#99cc99;">Hello, World!</span><span style="color:#d3d0c8;">&quot;, &quot;</span><span style="color:#99cc99;">text/plain</span><span style="color:#d3d0c8;">&quot;);
  88. </span><span style="color:#d3d0c8;"> });
  89. </span><span style="color:#d3d0c8;">
  90. </span><span style="color:#d3d0c8;"> svr.</span><span style="color:#6699cc;">listen</span><span style="color:#d3d0c8;">(&quot;</span><span style="color:#99cc99;">0.0.0.0</span><span style="color:#d3d0c8;">&quot;, </span><span style="color:#f99157;">8080</span><span style="color:#d3d0c8;">);
  91. </span><span style="color:#d3d0c8;">}
  92. </span></pre>
  93. </div><div class="code-light"><pre style="background-color:#eff1f5;">
  94. <span style="color:#b48ead;">#include </span><span style="color:#4f5b66;">&quot;</span><span style="color:#a3be8c;">httplib.h</span><span style="color:#4f5b66;">&quot;
  95. </span><span style="color:#4f5b66;">
  96. </span><span style="color:#b48ead;">int </span><span style="color:#8fa1b3;">main</span><span style="color:#4f5b66;">() {
  97. </span><span style="color:#4f5b66;"> httplib::Server svr;
  98. </span><span style="color:#4f5b66;">
  99. </span><span style="color:#4f5b66;"> svr.</span><span style="color:#8fa1b3;">Get</span><span style="color:#4f5b66;">(&quot;</span><span style="color:#a3be8c;">/</span><span style="color:#4f5b66;">&quot;, [](</span><span style="color:#b48ead;">const</span><span style="color:#4f5b66;"> httplib::Request&amp;, httplib::Response&amp; res) {
  100. </span><span style="color:#4f5b66;"> res.</span><span style="color:#8fa1b3;">set_content</span><span style="color:#4f5b66;">(&quot;</span><span style="color:#a3be8c;">Hello, World!</span><span style="color:#4f5b66;">&quot;, &quot;</span><span style="color:#a3be8c;">text/plain</span><span style="color:#4f5b66;">&quot;);
  101. </span><span style="color:#4f5b66;"> });
  102. </span><span style="color:#4f5b66;">
  103. </span><span style="color:#4f5b66;"> svr.</span><span style="color:#8fa1b3;">listen</span><span style="color:#4f5b66;">(&quot;</span><span style="color:#a3be8c;">0.0.0.0</span><span style="color:#4f5b66;">&quot;, </span><span style="color:#d08770;">8080</span><span style="color:#4f5b66;">);
  104. </span><span style="color:#4f5b66;">}
  105. </span></pre>
  106. </div>
  107. <p>In just a few lines, you have a server that responds to HTTP requests.</p>
  108. <h2>Compiling and Running</h2>
  109. <p>The sample code in this tutorial is written in C++17 for cleaner, more concise code. cpp-httplib itself can compile with C++11 as well.</p>
  110. <div class="code-dark"><pre style="background-color:#2d2d2d;">
  111. <span style="color:#747369;"># macOS
  112. </span><span style="color:#6699cc;">clang++</span><span style="color:#f2777a;"> -std</span><span style="color:#d3d0c8;">=c++17</span><span style="color:#f2777a;"> -o</span><span style="color:#d3d0c8;"> server server.cpp
  113. </span><span style="color:#d3d0c8;">
  114. </span><span style="color:#747369;"># Linux
  115. </span><span style="color:#747369;"># `-pthread`: cpp-httplib uses threads internally
  116. </span><span style="color:#6699cc;">clang++</span><span style="color:#f2777a;"> -std</span><span style="color:#d3d0c8;">=c++17</span><span style="color:#f2777a;"> -pthread -o</span><span style="color:#d3d0c8;"> server server.cpp
  117. </span><span style="color:#d3d0c8;">
  118. </span><span style="color:#747369;"># Windows (Developer Command Prompt)
  119. </span><span style="color:#747369;"># `/EHsc`: Enable C++ exception handling
  120. </span><span style="color:#6699cc;">cl</span><span style="color:#d3d0c8;"> /EHsc /std:c++17 server.cpp
  121. </span></pre>
  122. </div><div class="code-light"><pre style="background-color:#eff1f5;">
  123. <span style="color:#a7adba;"># macOS
  124. </span><span style="color:#8fa1b3;">clang++</span><span style="color:#bf616a;"> -std</span><span style="color:#4f5b66;">=c++17</span><span style="color:#bf616a;"> -o</span><span style="color:#4f5b66;"> server server.cpp
  125. </span><span style="color:#4f5b66;">
  126. </span><span style="color:#a7adba;"># Linux
  127. </span><span style="color:#a7adba;"># `-pthread`: cpp-httplib uses threads internally
  128. </span><span style="color:#8fa1b3;">clang++</span><span style="color:#bf616a;"> -std</span><span style="color:#4f5b66;">=c++17</span><span style="color:#bf616a;"> -pthread -o</span><span style="color:#4f5b66;"> server server.cpp
  129. </span><span style="color:#4f5b66;">
  130. </span><span style="color:#a7adba;"># Windows (Developer Command Prompt)
  131. </span><span style="color:#a7adba;"># `/EHsc`: Enable C++ exception handling
  132. </span><span style="color:#8fa1b3;">cl</span><span style="color:#4f5b66;"> /EHsc /std:c++17 server.cpp
  133. </span></pre>
  134. </div>
  135. <p>Once it compiles, run it.</p>
  136. <div class="code-dark"><pre style="background-color:#2d2d2d;">
  137. <span style="color:#747369;"># macOS / Linux
  138. </span><span style="color:#6699cc;">./server
  139. </span><span style="color:#d3d0c8;">
  140. </span><span style="color:#747369;"># Windows
  141. </span><span style="color:#6699cc;">server.exe
  142. </span></pre>
  143. </div><div class="code-light"><pre style="background-color:#eff1f5;">
  144. <span style="color:#a7adba;"># macOS / Linux
  145. </span><span style="color:#8fa1b3;">./server
  146. </span><span style="color:#4f5b66;">
  147. </span><span style="color:#a7adba;"># Windows
  148. </span><span style="color:#8fa1b3;">server.exe
  149. </span></pre>
  150. </div>
  151. <p>Open <code>http://localhost:8080</code> in your browser. If you see "Hello, World!", you're all set.</p>
  152. <p>You can also verify with <code>curl</code>.</p>
  153. <div class="code-dark"><pre style="background-color:#2d2d2d;">
  154. <span style="color:#6699cc;">curl</span><span style="color:#d3d0c8;"> http://localhost:8080/
  155. </span><span style="color:#747369;"># Hello, World!
  156. </span></pre>
  157. </div><div class="code-light"><pre style="background-color:#eff1f5;">
  158. <span style="color:#8fa1b3;">curl</span><span style="color:#4f5b66;"> http://localhost:8080/
  159. </span><span style="color:#a7adba;"># Hello, World!
  160. </span></pre>
  161. </div>
  162. <p>To stop the server, press <code>Ctrl+C</code> in your terminal.</p>
  163. <h2>Next Steps</h2>
  164. <p>Now you know the basics of running a server. Next, let's look at the client side. cpp-httplib also comes with HTTP client functionality.</p>
  165. <p><strong>Next:</strong> <a href="../02-basic-client">Basic Client</a></p>
  166. </article>
  167. </main>
  168. </div>
  169. <footer class="footer">
  170. &copy; 2026 yhirose. All rights reserved.
  171. </footer>
  172. <script src="&#x2F;cpp-httplib/js/main.js"></script>
  173. </body>
  174. </html>