Chapter VI modified specification (SPEC) class

Chapter six Modify specifications （SPEC） class

summary

The following table lists the reasons for modifying the specification class and briefly summarizes the changes required ：

reason	change
Update or replace specifications	Manually modify OpenAPI XData Block or by regenerating the canonical class .
Enable REST Services to support CORS	Manually modify OpenAPI XData block ; Also add a class parameter and create a custom scheduling superclass .
Enable REST Services to support Web conversation	Add class parameters .
Specify the permissions required to use the endpoint	Manually modify OpenAPI XData block .
Override the default content type 、 Response character set or input stream processing	Add class parameters .
Specify a non default name for the service method	Manually modify OpenAPI XData block .

Whenever you compile a specification class , The compiler will regenerate the scheduling class and update the implementation class in the same package .

Cover content types 、 Response character set or input stream processing

Just add class parameters to the canonical class and recompile , Can be covered REST Several key aspects of service .

• By default ,REST Service needs application/json Content type . Do you want to overwrite it , Please add the following to the specification class ：

Parameter CONTENTTYPE = "some-content-type";

among some-content-type yes MIME Content type .

• By default ,REST The response message of the service adopts UTF-8 Format . Do you want to overwrite it , Please add the following to the specification class ：

Parameter CHARSET = "some-character-set";

among some-content-type-here Is the name of the character set .

• By default ,REST The service converts the input character stream to Unicode. How about this , Please add the following to the specification class ：

Parameter CONVERTINPUTSTREAM = 0";

Then recompile . Then copy these changes to the scheduling class .

Override the name of the service method

By default , Compiler uses operation operationId To determine the corresponding REST The name of the method called . You can specify different names . So , Please add the following content to the specification class OpenAPI XData Operation in block ：

"x-ISC_ServiceMethod":"alternatename"

Example

    "/pets":{
    
      "get":{
    
        "description":"Returns all pets from the system that the user has access to",
        "operationId":"findPets",
        "x-ISC_ServiceMethod":"ReturnPets",
        "produces":[
          "application/json",
          "application/xml",
          "text/xml",
          "text/html"
        ],

Then recompile . Then the compiler adds this new method to the scheduling and implementation classes . Be sure to edit the implementation class and provide an implementation for this new method .