api-farmer 0.0.4 → 0.0.5

package/README.md

@@ -2,11 +2,11 @@
 
 ### Intro
 
-API module generation tool based on `Openapi3 / Swagger2`.
+API module generation tool based on `Openapi3/Swagger2`.
 
 ### Features
 
-- 🌐   Supports generating all API modules from `OpenAPI 3/Swagger 2 schemas`
+- 🌐   Supports generating all API modules from `OpenAPI3/Swagger2 schemas`
 - 📦   Supports generating `ts/js` modules
 - 🛠️   Comprehensive `ts type` generation
 - ✏️   Supports custom `ejs` templates for tailored content generation
@@ -38,7 +38,7 @@ export default defineConfig({
   input: './schema.yaml',
   // generated codes output path, defaults './src/apis'
   output: './src/apis',
-  // axle or axios, defaults axle.
+  // 'axle' or 'axios', defaults 'axle'.
   preset: 'axios',
 })
 ```
@@ -52,15 +52,34 @@ npx af
 > [!TIP]
 > The generated content does not include the integration of the request client.
 
+#### Some Examples
+
+Some simple usage examples can be found [here](fixtures)
+
 ### Custom EJS Template
 
-Create api-farmer.ejs in the project root path. The template content can refer to the following:
+Create `api-farmer.ejs` in the project root, which will replace the `preset` template.
+The template format can refer to the preset template listed below:
 
 - [Axle](templates/axle.ejs)
 - [Axios](templates/axios.ejs)
 
 See the bottom of the document for template variable definitions.
 
+### Status Code Strategy
+
+`Restful API` recommends using different successful http status codes for different methods, such as `get: 200`, `post: 201`, etc. If you don't need this strategy, you can set `statusCodeStrategy` to `loose`
+
+```ts
+// api-farmer.config.ts
+import { defineConfig } from 'api-farmer'
+
+export default defineConfig({
+  // 'strict' or 'loose', defaults 'strict'
+  statusCodeStrategy: 'loose',
+})
+```
+
 ### Transformer API
 
 You can use the Transformer API to further define template variables, which will override the default transformation rules.
@@ -72,6 +91,7 @@ import { defineConfig } from 'api-farmer'
 export default defineConfig({
   transformer: {
     moduleName({ name }) {
+      // The new module name.
       return `${name}.generated`
     },
     verb() {},
@@ -127,7 +147,8 @@ export interface Config {
    */
   preset?: Preset
   /**
-   * The status code strategy to use. loose: all success status codes are 200, strict: use the openapi recommended success status codes.
+   * The status code strategy to use.
+   * loose: all success status codes are 200, strict: use the openapi recommended success status codes.
    */
   statusCodeStrategy?: StatusCodeStrategy
   /**
@@ -176,55 +197,73 @@ export interface ApiModule {
 
 export interface ApiModulePayload {
   /**
-   * The name of the API function/dispatcher, such as apiGetUsers, apiCreatePost, apiUpdateComment, etc.
+   * The name of the API function/dispatcher,
+   * such as apiGetUsers, apiCreatePost, apiUpdateComment, etc.
    */
   fn: string
   /**
-   * The URL of the API endpoint, such as /users, /posts, /comments, etc.
+   * The URL of the API endpoint,
+   * such as /users, /posts, /comments, etc.
    */
   url: string
   /**
-   * The HTTP method of the API endpoint, such as get, post, put, delete, etc.
+   * The HTTP method of the API endpoint,
+   * such as get, post, put, delete, etc.
    */
   method: string
   /**
-   * The HTTP verb of the API endpoint, such as Get, Create, Update, Delete, etc.
+   * The HTTP verb of the API endpoint,
+   * such as Get, Create, Update, Delete, etc.
    */
   verb: string
   /**
-   * The entity name of the API endpoint, such as User, Comment, Post, etc.
+   * The entity name of the API endpoint,
+   * such as User, Comment, Post, etc.
    */
   entity: string
   /**
-   * The type name of the API endpoint, such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
+   * The type name of the API endpoint,
+   * such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
    */
   type: string
   /**
-   * The value of the type of the API endpoint, such as paths['/users']['get'], paths['/posts']['post'], paths['/comments']['put'], etc.
+   * The value of the type of the API endpoint,
+   * such as paths['/users']['get'], paths['/posts']['post'], paths['/comments']['put'], etc.
    */
   typeValue: string
   /**
-   * The type name of the query parameters of the API endpoint, such as ApiGetUsersQuery, ApiCreatePostQuery, ApiUpdateCommentQuery, etc.
+   * The type name of the query parameters of the API endpoint,
+   * such as ApiGetUsersQuery, ApiCreatePostQuery, ApiUpdateCommentQuery, etc.
    */
   typeQuery: string
   /**
-   * The value of the type of the query parameters of the API endpoint, such as ApiGetUsersQuery['parameters']['query'], ApiCreatePostQuery['parameters']['query'], ApiUpdateCommentQuery['parameters']['query'], etc.
+   * The value of the type of the query parameters of the API endpoint,
+   * such as ApiGetUsersQuery['parameters']['query'], ApiCreatePostQuery['parameters']['query'],
+   * ApiUpdateCommentQuery['parameters']['query'], etc.
    */
   typeQueryValue: string
   /**
-   * The type name of the request body of the API endpoint, such as ApiGetUsersRequestBody, ApiCreatePostRequestBody, ApiUpdateCommentRequestBody, etc.
+   * The type name of the request body of the API endpoint,
+   * such as ApiGetUsersRequestBody, ApiCreatePostRequestBody, ApiUpdateCommentRequestBody, etc.
    */
   typeRequestBody: string
   /**
-   * The value of the type of the request body of the API endpoint, such as ApiGetUsersRequestBody['requestBody']['content']['application/json'], ApiCreatePostRequestBody['requestBody']['content']['application/json'], ApiUpdateCommentRequestBody['requestBody']['content']['application/json'], etc.
+   * The value of the type of the request body of the API endpoint,
+   * such as ApiGetUsersRequestBody['requestBody']['content']['application/json'],
+   * ApiCreatePostRequestBody['requestBody']['content']['application/json'],
+   * ApiUpdateCommentRequestBody['requestBody']['content']['application/json'], etc.
    */
   typeRequestBodyValue: string
   /**
-   * The type name of the response body of the API endpoint, such as ApiGetUsersResponseBody, ApiCreatePostResponseBody, ApiUpdateCommentResponseBody, etc.
+   * The type name of the response body of the API endpoint,
+   * such as ApiGetUsersResponseBody, ApiCreatePostResponseBody, ApiUpdateCommentResponseBody, etc.
    */
   typeResponseBody: string
   /**
-   * The value of the type of the response body of the API endpoint, such as ApiGetUsersResponseBody['responses']['200']['content']['application/json'], ApiCreatePostResponseBody['responses']['201']['content']['application/json'], ApiUpdateCommentResponseBody['responses']['200']['content']['application/json'], etc.
+   * The value of the type of the response body of the API endpoint,
+   * such as ApiGetUsersResponseBody['responses']['200']['content']['application/json'],
+   * ApiCreatePostResponseBody['responses']['201']['content']['application/json'],
+   * ApiUpdateCommentResponseBody['responses']['200']['content']['application/json'], etc.
    */
   typeResponseBodyValue: string
 }

package/dist/{chunk-ZLLNTCL2.js → chunk-6T5EWOBD.js}

@@ -22838,7 +22838,7 @@ function partitionApiModules(schema2, transformer, options8) {
         const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({ type: type2 }) : "never";
         const typeResponseBody = transformer.typeResponseBody({ verb, entity });
         const statusCode = statusCodes[method] ?? 200;
-        const mime = (operation.responses?.[statusCode]).content?.["application/json"] ? "application/json" : "*/*";
+        const mime = operation.responses?.[statusCode]?.content?.["application/json"] ? "application/json" : "*/*";
         const typeResponseBodyValue = hasResponseBody(operation) ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
         payloads3.push({
           fn,

package/dist/cli.cjs

@@ -102113,7 +102113,7 @@ function partitionApiModules(schema2, transformer, options8) {
         const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({ type: type2 }) : "never";
         const typeResponseBody = transformer.typeResponseBody({ verb, entity });
         const statusCode = statusCodes[method] ?? 200;
-        const mime = (operation.responses?.[statusCode]).content?.["application/json"] ? "application/json" : "*/*";
+        const mime = operation.responses?.[statusCode]?.content?.["application/json"] ? "application/json" : "*/*";
         const typeResponseBodyValue = hasResponseBody(operation) ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
         payloads3.push({
           fn: fn8,

package/dist/cli.js

@@ -9,7 +9,7 @@ import { Command } from "commander";
 var program = new Command();
 program.version(getCliVersion());
 program.action(async () => {
-  const { generate } = await import("./generate-23Q2CMLJ.js");
+  const { generate } = await import("./generate-544AKFJX.js");
   return generate();
 });
 program.parse();

package/dist/{generate-23Q2CMLJ.js → generate-544AKFJX.js}

@@ -3,7 +3,7 @@ import {
   generateTypes,
   partitionApiModules,
   renderApiModules
-} from "./chunk-ZLLNTCL2.js";
+} from "./chunk-6T5EWOBD.js";
 import "./chunk-6N4OHGAC.js";
 import "./chunk-6OIOYGN7.js";
 export {

package/dist/index.cjs

@@ -102150,7 +102150,7 @@ function partitionApiModules(schema2, transformer, options8) {
         const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({ type: type2 }) : "never";
         const typeResponseBody = transformer.typeResponseBody({ verb, entity });
         const statusCode = statusCodes[method] ?? 200;
-        const mime = (operation.responses?.[statusCode]).content?.["application/json"] ? "application/json" : "*/*";
+        const mime = operation.responses?.[statusCode]?.content?.["application/json"] ? "application/json" : "*/*";
         const typeResponseBodyValue = hasResponseBody(operation) ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
         payloads3.push({
           fn: fn8,

package/dist/index.js

@@ -19,7 +19,7 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-ZLLNTCL2.js";
+} from "./chunk-6T5EWOBD.js";
 import {
   createStatusCodesByStrategy,
   getCliVersion,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "api-farmer",
-  "version": "0.0.4",
-  "description": "A cli to generate apis from a schema",
+  "version": "0.0.5",
+  "description": "API module generation tool based on Openapi3/Swagger2.",
   "keywords": [
     "cli",
     "api generator",
@@ -33,7 +33,8 @@
     "af": "dist/cli.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
   "simple-git-hooks": {
     "pre-commit": "pnpm exec nano-staged --allow-empty",

package/templates/axios.ejs

@@ -0,0 +1,42 @@
+<% if (ts) { %> import { type AxiosRequestConfig } from 'axios' <% } %>
+import { request } from '@/request'
+<% if (ts) { %> import { type paths } from './<%- typesFilename %>' <% } %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+export const <%- payload.fn %> = (config<% if (ts) { %>: AxiosRequestConfig<<%- payload.typeRequestBody %>> <% } %>) 
+=> request<% if (ts) { %><any, Res<<%- payload.typeResponseBody %>>><% } %>({
+  url: '<%- payload.url %>', 
+  method: '<%- payload.method %>',
+  ...config
+})
+
+<% }) %>
+
+<% if (ts) { %>
+<% apiModule.payloads.forEach(payload => { %> -%>
+export type <%- payload.type %> = <%- payload.typeValue %>
+
+<% }) %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+  <% if (payload.typeQueryValue) { %>
+  export type <%- payload.typeQuery %> = <%- payload.typeQueryValue %>
+  
+<% } %>
+<% }) %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+<% if (payload.typeRequestBodyValue) { %>
+export type <%- payload.typeRequestBody %> = <%- payload.typeRequestBodyValue %>
+
+<% } %>
+<% }) %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+<% if (payload.typeResponseBodyValue) { %>
+export type <%- payload.typeResponseBody %> = <%- payload.typeResponseBodyValue %>
+  
+<% } %>
+<% }) %>
+<% } %>
+

package/templates/axle.ejs

@@ -0,0 +1,36 @@
+import { api } from '@/request'
+<% if (ts) { %> import { type paths } from './<%- typesFilename %>' <% } %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+export const <%- payload.fn %> = api<% if (ts) { %><Res<<%- payload.typeResponseBody %>>, <%- payload.typeRequestBody %>><% } %>('<%- payload.url %>', '<%- payload.method %>')
+
+<% }) %>
+
+<% if (ts) { %>
+<% apiModule.payloads.forEach(payload => { %> -%>
+export type <%- payload.type %> = <%- payload.typeValue %>
+
+<% }) %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+  <% if (payload.typeQueryValue) { %>
+  export type <%- payload.typeQuery %> = <%- payload.typeQueryValue %>
+  
+<% } %>
+<% }) %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+<% if (payload.typeRequestBodyValue) { %>
+export type <%- payload.typeRequestBody %> = <%- payload.typeRequestBodyValue %>
+
+<% } %>
+<% }) %>
+
+<% apiModule.payloads.forEach(payload => { %> -%>
+<% if (payload.typeResponseBodyValue) { %>
+export type <%- payload.typeResponseBody %> = <%- payload.typeResponseBodyValue %>
+  
+<% } %>
+<% }) %>
+<% } %>
+