Get json schema of parameters from a function about ts-json-schema-generator HOT 11 CLOSED

Yes, it would be possible but I do not intend to support it for now.

from ts-json-schema-generator.

Could you give me some direction to implement it by my own? I might fork your repo and give a try.

from ts-json-schema-generator.

You need to add a parser, type, and formatter for functions. You can look at the existing types we support.

from ts-json-schema-generator.

@apiel, have you considered creating an interface to wrap the input arguments?

Here's what I mean:

export interface GetListInput {
    foo: string;
}

// An interface to define the InputParams to the function.
export interface InputParams {
  input: GetListInput;
  input2: string;
}

export function getList({input, input2}: InputParams) {
    // some code
}

If getList is not a function under your control,

export const wrapGetList = ({input, input2}: InputParams) => getList(input, input2);

from ts-json-schema-generator.

Yes I thought about it but it doesn't really fit with what I want to achieve. I work on a tool to automatically generate the communication protocole between backend and frontend https://github.com/apiel/isomor , and since I am as using a transpiler for it, I though it would be great to check for types in the generated endpoints.
Also I could use the JSON schema to improve the generated swagger documentation.

from ts-json-schema-generator.

I somehow get it to work:
apiel@010ce2d

now I am not so sure about if I need the withCircular. Also the getTypeId I am not really sure about what I did...

yarn run run --path ~/test/endpoint.ts --type getList (I am actually wondering, yarn run run is a bit strange, do I use it in a wrong way?)

result to:

{
  "$ref": "#/definitions/getList",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "definitions": {
    "GetListInput": {
      "additionalProperties": false,
      "properties": {
        "foo": {
          "type": "string"
        }
      },
      "required": [
        "foo"
      ],
      "type": "object"
    },
    "getList": {
      "additionalProperties": false,
      "properties": {
        "input": {
          "$ref": "#/definitions/GetListInput"
        },
        "input2": {
          "type": "string"
        }
      },
      "required": [
        "input",
        "input2"
      ],
      "type": "object"
    }
  }

I will then do the same for arrowFunction (and try as well with class method).
Is there any chance to merged a PR to your repo or would it be out of scope?

from ts-json-schema-generator.

Here is the last version https://github.com/apiel/isomor/blob/master/packages/isomor-json-schema-generator/src/NodeParser/FuncTypeNodeParser.ts

and https://github.com/apiel/isomor/blob/master/packages/isomor-json-schema-generator/src/SchemaGenerator.ts#L74

But after making some research, I think I should have used tuple validation: https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation

Would be great to get this code merge, then I would not need my custom repo. Please let me know which kind of changes I need to do, to make it mergeable...

I was looking at https://github.com/vega/ts-json-schema-generator/blob/master/src/Type/ArrayType.ts but I don't really see how to implement tuple. Is tuple already supported by ts-json-schema-generator ?

from ts-json-schema-generator.

I don't plan to support functions until json schema has support for them and ajv also validates them.

from ts-json-schema-generator.

Make sense ;-) What's about tuple validation for array? https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation

from ts-json-schema-generator.

That would make sense. I haven't checked, but we may already support it.

from ts-json-schema-generator.

There's something wrong here: you are only mapping the input parameters of the function, not the output
It can be void or something else.

In your schema representation, how do you want to represent it ?

I'm really interested to use or develop it if we found a correct representation of a method / function here

from ts-json-schema-generator.