Skip to content

Commit a93b223

Browse files
committed
docs: update
1 parent 7dea5cb commit a93b223

File tree

4 files changed

+29
-7
lines changed

4 files changed

+29
-7
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ npx swagger-typescript-api-es@latest -u https://petstore.swagger.io/v2/swagger.j
3434
npm i swagger-typescript-api-es@latest --save-dev
3535
```
3636

37-
- Create a file `swagger-typescript-api.config.config.ts` in the root of the project
37+
- Create a file `swagger-typescript-api.config.ts` in the root of the project
3838

3939
```ts
4040
import { defaultConfig } from 'swagger-typescript-api-es';
@@ -45,7 +45,11 @@ export default defaultConfig({
4545
url: 'http://localhost:5002/api-json',
4646
httpClientType: 'axios',
4747
});
48+
```
49+
50+
- Options
4851

52+
```ts
4953
// Options
5054
interface IOptions {
5155
/**

docs/index.html

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ <h2 class="heading-anchor" id="install"><a class="anchor" href="#install">#</a>I
274274
</div>
275275
</div></p>
276276
<ul>
277-
<li>Create a file <code>swagger-typescript-api.config.config.ts</code> in the root of the project</li>
277+
<li>Create a file <code>swagger-typescript-api.config.ts</code> in the root of the project</li>
278278
</ul>
279279

280280
<div class="code-blocks markdown-it-code-copy code-blocks-group ts ">
@@ -288,9 +288,23 @@ <h2 class="heading-anchor" id="install"><a class="anchor" href="#install">#</a>I
288288
<span class="line"><span class="space"> </span><span class="space"> </span><span style="color:#D7D7D7;--shiki-dark:#D7D7D7"><span class="twoslash-hover"><span class="twoslash-popup-container ingore-twoslash"><code class="twoslash-popup-code"><span class="line"><span style="color:#D7D7D7;--shiki-dark:#D7D7D7">IOptions</span><span style="color:#88898F;--shiki-dark:#88898F">.</span><span style="color:#D7D7D7;--shiki-dark:#D7D7D7">output: string</span></span></code><div class="twoslash-popup-docs"><p>output path of typescript api file (default: "./")</p></div></span>output</span></span><span style="color:#88898F;--shiki-dark:#88898F">:</span><span class="space"> </span><span style="color:#88898F;--shiki-dark:#88898F">'</span><span style="color:#E3CF65;--shiki-dark:#E3CF65">./src/apis/axios-gentype</span><span style="color:#88898F;--shiki-dark:#88898F">'</span><span style="color:#88898F;--shiki-dark:#88898F">,</span></span>
289289
<span class="line"><span class="space"> </span><span class="space"> </span><span style="color:#D7D7D7;--shiki-dark:#D7D7D7"><span class="twoslash-hover"><span class="twoslash-popup-container ingore-twoslash"><code class="twoslash-popup-code"><span class="line"><span style="color:#D7D7D7;--shiki-dark:#D7D7D7">IOptions</span><span style="color:#88898F;--shiki-dark:#88898F">.</span><span style="color:#D7D7D7;--shiki-dark:#D7D7D7">url: string</span></span></code><div class="twoslash-popup-docs"><p>path/url to swagger scheme</p></div></span>url</span></span><span style="color:#88898F;--shiki-dark:#88898F">:</span><span class="space"> </span><span style="color:#88898F;--shiki-dark:#88898F">'</span><span style="color:#E3CF65;--shiki-dark:#E3CF65">http://localhost:5002/api-json</span><span style="color:#88898F;--shiki-dark:#88898F">'</span><span style="color:#88898F;--shiki-dark:#88898F">,</span></span>
290290
<span class="line"><span class="space"> </span><span class="space"> </span><span style="color:#D7D7D7;--shiki-dark:#D7D7D7"><span class="twoslash-hover"><span class="twoslash-popup-container ingore-twoslash"><code class="twoslash-popup-code"><span class="line"><span style="color:#D7D7D7;--shiki-dark:#D7D7D7">IOptions</span><span style="color:#88898F;--shiki-dark:#88898F">.</span><span style="color:#D7D7D7;--shiki-dark:#D7D7D7">httpClientType</span><span style="color:#FB7DA7;--shiki-dark:#FB7DA7">?:</span><span style="color:#88898F;--shiki-dark:#88898F"> "</span><span style="color:#E3CF65;--shiki-dark:#E3CF65">axios</span><span style="color:#88898F;--shiki-dark:#88898F">"</span><span style="color:#FB7DA7;--shiki-dark:#FB7DA7"> |</span><span style="color:#88898F;--shiki-dark:#88898F"> "</span><span style="color:#E3CF65;--shiki-dark:#E3CF65">fetch</span><span style="color:#88898F;--shiki-dark:#88898F">"</span><span style="color:#FB7DA7;--shiki-dark:#FB7DA7"> |</span><span style="color:#AF98E6;--shiki-dark:#AF98E6"> undefined</span></span></code></span>httpClientType</span></span><span style="color:#88898F;--shiki-dark:#88898F">:</span><span class="space"> </span><span style="color:#88898F;--shiki-dark:#88898F">'</span><span style="color:#E3CF65;--shiki-dark:#E3CF65">axios</span><span style="color:#88898F;--shiki-dark:#88898F">'</span><span style="color:#88898F;--shiki-dark:#88898F">,</span></span>
291-
<span class="line"><span style="color: #179fff">}</span><span style="color: #ffd700">)</span><span style="color:#88898F;--shiki-dark:#88898F">;</span></span>
292-
<span class="line"></span>
293-
<span class="line"><span style="color:#5E6173;--shiki-dark:#5E6173">//</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">Options</span></span>
291+
<span class="line"><span style="color: #179fff">}</span><span style="color: #ffd700">)</span><span style="color:#88898F;--shiki-dark:#88898F">;</span></span></code></pre>
292+
293+
<span class="code-blocks-lang">ts</span>
294+
<button class="btn-copy">
295+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#555555" d="M9 18q-.825 0-1.412-.587T7 16V4q0-.825.588-1.412T9 2h9q.825 0 1.413.588T20 4v12q0 .825-.587 1.413T18 18zm0-2h9V4H9zm-4 6q-.825 0-1.412-.587T3 20V7q0-.425.288-.712T4 6q.425 0 .713.288T5 7v13h10q.425 0 .713.288T16 21q0 .425-.288.713T15 22zm4-6V4z"/></svg>
296+
</button>
297+
</div>
298+
</div>
299+
<ul>
300+
<li>Options</li>
301+
</ul>
302+
303+
<div class="code-blocks markdown-it-code-copy code-blocks-group ts ">
304+
305+
306+
<div class="code-blocks-pre">
307+
<pre class="shiki shiki-themes lucy lucy twoslash lsp" style="background-color:#1a1d27;--shiki-dark-bg:#1a1d27;color:#d7d7d7;--shiki-dark:#d7d7d7" tabindex="0"><code class="language-ts"><span class="line"><span style="color:#5E6173;--shiki-dark:#5E6173">//</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">Options</span></span>
294308
<span class="line"><span style="color:#51C7DA;--shiki-dark:#51C7DA">interface</span><span style="color:#76C5A4;--shiki-dark:#76C5A4"> </span><span style="color:#76C5A4;--shiki-dark:#76C5A4">IOptions</span><span class="space"> </span><span style="color: #179fff">{</span></span>
295309
<span class="line"><span class="space"> </span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">/**</span></span>
296310
<span class="line"><span class="space"> </span><span class="space"> </span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">*</span><span class="space"> </span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">name</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">of</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">output</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">typescript</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">api</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">file</span><span class="space"> </span><span style="color: #ffd700">(</span><span style="color:#5E6173;--shiki-dark:#5E6173">d</span><span style="color:#5E6173;--shiki-dark:#5E6173">e</span><span style="color:#5E6173;--shiki-dark:#5E6173">f</span><span style="color:#5E6173;--shiki-dark:#5E6173">a</span><span style="color:#5E6173;--shiki-dark:#5E6173">u</span><span style="color:#5E6173;--shiki-dark:#5E6173">l</span><span style="color:#5E6173;--shiki-dark:#5E6173">t</span><span style="color:#5E6173;--shiki-dark:#5E6173">:</span><span class="space"> </span><span style="color:#5E6173;--shiki-dark:#5E6173">"</span><span style="color:#5E6173;--shiki-dark:#5E6173">A</span><span style="color:#5E6173;--shiki-dark:#5E6173">p</span><span style="color:#5E6173;--shiki-dark:#5E6173">i</span><span style="color:#5E6173;--shiki-dark:#5E6173">.</span><span style="color:#5E6173;--shiki-dark:#5E6173">t</span><span style="color:#5E6173;--shiki-dark:#5E6173">s</span><span style="color:#5E6173;--shiki-dark:#5E6173">"</span><span style="color: #ffd700">)</span></span>

docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ bun i swagger-typescript-api-es@latest --save-dev
8686

8787
:::code-group-close
8888

89-
- Create a file `swagger-typescript-api.config.config.ts` in the root of the project
89+
- Create a file `swagger-typescript-api.config.ts` in the root of the project
9090

9191
```ts twoslash
9292
import { defaultConfig } from 'swagger-typescript-api-es';
@@ -97,7 +97,11 @@ export default defaultConfig({
9797
url: 'http://localhost:5002/api-json',
9898
httpClientType: 'axios',
9999
});
100+
```
101+
102+
- Options
100103

104+
```ts twoslash
101105
// Options
102106
interface IOptions {
103107
/**

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "swagger-typescript-api-es",
3-
"version": "0.0.7",
3+
"version": "0.0.8",
44
"license": "MIT",
55
"type": "module",
66
"main": "./dist/index.mjs",

0 commit comments

Comments
 (0)