migrate new GitHub users API

[well-balanced]

Description

Implements #286

• Call v2/GithubUsers/{username} from the frontend
• Remove the old API /github/users

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

[ZibanPirate]

this is a well written PR, couple more changes suggested, and we good to go 👌🏽

[ZibanPirate]

there is no need to verify a service response, so the code from line 25 to 27 can be removed as well as on line 7

[well-balanced]

yesss! I've just fixed it.
but can I ask a question? I added these lines for documentation. if I do not specify class object like a GithubUserDto into ResponseDto, I couldn't see any details in http://localhost:7070/v2/docs/ are there any issues when a user object is wrapped in a DTO object? It should be tiresome, but I would be learned lots of things from your reply :)

[ZibanPirate]

well, as i mentioned in the new comments, the nested objects inside the dto class has to be dto classes too, otherwise OpenApi will not pick them as specs in the docs, you also need to decorate them with @ValidateNested() (or @ValidateNested({ each: true }) and @Type(() => YouClassDto) for array of objects)

[ZibanPirate]

one last change and we're good to go!

[well-balanced]

Type 'GitHubUserApiResponse' is not assignable to type 'GithubUserDto'.
  Types of property 'id' are incompatible.
    Type 'number' is not assignable to type 'string'.

I think It's a conflict between GithubUserDto and GitHubUserApiResponse

export class GithubUserDto implements GithubUser {
  ...
  @IsString()
  id!: string;
  ...
}

export interface GitHubUserApiResponse {
  ...
  id: number;
  ...
}

[ZibanPirate]

yes you're correct, we need to do 3 changes:

1. in common/src/types/index.ts change line 43 to:

  id: number;

2. in api/src/github/dto.ts change line 10 to:

  id!: number;

3. in api/test/mocks.ts change lines 6, 14 and 22 to:

  id: 1,

  id: 2,

  id: 3,

[well-balanced]

@ZibanPirate I'm sorry to late 😭 I've just implemented earlier suggestion :)

[ZibanPirate]

no worries, thanks for your well balanced PR ;) merging ...