search

caicloud / nirvana

Golang Restful API Framework for Productivity
https://caicloud.github.io/nirvana/
Apache License 2.0
520 stars 105 forks source link

feat(*): handle inline struct in API docs generation #437

Closed iawia002 closed 3 years ago

iawia002 commented 3 years ago

What this PR does / why we need it:

We take the below struct for example:

type T2 struct {
    Name []string `json:"Name1"`
}

type T1 struct {
    CC map[string]string `json:"CC"`
}

type Test struct {
    T2 `json:",inline"`
    T1 T1     `json:"T1"`
    AA string `json:"AA"`
}

type T4 struct {
    AA string `json:"AA"`
}

type T3 struct {
    AA []string `json:"AA"`
    T4 T4       `json:"T4"`
}

type Workload struct {
    Test `json:",inline"`
    Name string `json:"Name"`
    T3   T3     `json:"T3"`
}

Before:

Screen Shot 2021-01-14 at 11 10 36

After:

Screen Shot 2021-01-14 at 11 09 43

Which issue(s) this PR is related to (optional, link to 3rd issue(s)):

Fixes #

Reference to #

Special notes for your reviewer:

/cc @xpofei

Release note:

Handle inline struct in API docs generation.
xpofei commented 3 years ago

/lgtm

iawia002 commented 3 years ago

/approve

caicloud-bot commented 3 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: iawia002, xpofei

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/caicloud/nirvana/blob/master/OWNERS)~~ [iawia002] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
iawia002 commented 3 years ago

/cherrypick release-0.3

caicloud-bot commented 3 years ago

@iawia002: new pull request created: #441

In response to [this](https://github.com/caicloud/nirvana/pull/437#issuecomment-763404755): >/cherrypick release-0.3 Instructions for interacting with me using PR comments are available [here](https://github.com/caicloud/engineering/blob/master/docs/caicloud_bot.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.